Request a downloadable insight report

Returns one or more links to the insight report. When the report generation takes too much time to complete in a timely manner, returns HTTP 408. In this case the request have to be repeated after a minute. Once the report is generated, consecutive requests are returned immediately. Each successful response returns one or more download links that expires in 5 minutes. The client application consuming the API shall download the file within this period or send additional request to the API.

Name	Description	Type	Required	Default
id	Insight ID	String
file_format	Insight report file format. Available formats: xlsx, pdf Accepted Values: [ xlsx,pdf]	String		xlsx

Name	Description	Type	Required	Default
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
Accept	Response data format. Default is application/json. Can be used through the query parameter format or using the header Accept. Accepted Values: [ application/json,application/xml]	String		json

Name	Description	Type	Required	Default
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
format	Response data format. Default is json. Can be used through the query parameter format or using the header Accept. Accepted Values: [ json,xml]	String		json
token	Access API key.	String
with_model_information	If set to true returns the model names as part of the response.	Boolean		false
ignore_cache	New file will be generated	Boolean		false
adjust_columns	No adjust or wrap text in XLSX cell Accepted Values: [ no,wrap]	String		no
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
count	Limit the amount of latest time-points returned, by the number specified.	Integer		3650
blank_observations	If set to true, will return empty time-points which oterwise are omitted. Accepted Values: [ filter,blank,N/A,zero,custom]	String		filter
orientation	Columns/rows orientation Accepted Values: [ rows,cols]	String		cols
order	Sort order - Asc/Desc Accepted Values: [ asc,desc]	String		asc
decimal_places	Decimal places for the time-points values	Number		3
date_format	Time-points date format	String

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	Description	Type
200	Insight download information	InsightDownloadResult
400	Incorrect input parameters.	BadRequest
401	Authorization error.	AuthorizationError
403	Incorrect user permissions.	PermissionsError
404	Requested entity not found.	NotFound
408	The document is still being generated. The request have to be repeated after a minute.	ResponseError
415	Unsupported data format. Only json, xml are supported.	UnsupportedMedia
429	Too many requests were send or limit exceeded.	TooManyRequests
500	Internal Server Error.	InternalError