GET /series/{id}/visual

Returns visual image

Returns some chart/map/table image

Path Parameters

Name Description Type Required Default
id Series ID or Series Code to return. Accepts only one series ID or series Code. String

Header Parameters

Name Description Type Required Default
Accept Response data format. Default is image/png.
Accepted Values: [ image/png,image/jpeg]
String image/png
Accept-Language Preferred language code in which data shall be returned. Defaults to English if no translation in the specified language is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
Accepted Values: [ en,zh,ru,id,jp]
String en

Query Parameters

Name Description Type Required Default
format Response data format. Default is png
Accepted Values: [ png,jpeg]
String png
lang Preferred language code in which data will be returned. Defaults to English if no translation in the language specified is available. Can be used through the query parameter query or using the header Accept-Language.

en - English
zh - Chinese
ru - Russian
id - Indonesian
jp - Japanese
Accepted Values: [ en,zh,ru,id,jp]
String en
token Access API key. String
start_date Limits the start date after which the time-points will be returned. String
end_date Limits the end date before which the time-points will be returned. String
forecast_only If it is true result will only contain series with forecast Boolean false
with_release_only If it is true result will only contain series with released schedule Boolean false
with_replacements_only If it is true result will only contain series with suggestions Boolean false
with_observations_only If it is true result will not contain series without observations Boolean false
width Image width Number
height Image height Number
period Series time-pints mask. Example: 10y, 20m, 12d, 4w Number
type Visual type
Accepted Values: [ chart,line_chart,spline_chart,step_line_chart,scatter_chart,area_chart,stacked_area_chart,column_chart,stacked_column_chart,bar_chart,stacked_bar_chart,pie_chart,map,world_map,africa_map,asia_map,europe_map,europe_without_russia_map,european_union_map,middle_east_map,north_america_map,oceania_map,south_america_map,china_map,russia_disputed_territories_map,india_map,heatmap,histogram,table]
String chart

Responses

All API calls have response size limit of 10MB! If you are planning to request a bulky item collection, please consider using the corresponding API request parameters to limit your response.

Status Code Type Type
200 Visual Image String
400 Incorrect input parameters. BadRequest
401 Authorization error. AuthorizationError
403 Incorrect user permissions. PermissionsError
404 Requested entity not found. NotFound
415 Unsupported data format. Only json, xml, csv are supported. UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 Internal Server Error. InternalError
API Query Builder
Query
Query Result