GET /insights/{id}/download/{file_format}

请求可下载的数据模板报告。

返回指向数据模板报告的一个或多个链接。当报告生成花费太多时间而无法准时完成时,返回HTTP 408。在这种情况下,必须在一分钟后重复请求。一旦生成报告,立即返回连续的请求。每一次成功响应都会返回一个或多个下载链接,这些链接将在5分钟内过期。使用API的客户端应用程序应在此期间内下载文件或向API发送其他请求。

路径参数

名称 描述 类型 需要 默认
id 数据模板ID String
file_format 数据模板报告文件格式
Accepted Values: [ xlsx,pdf]
String xlsx

Header参数

名称 描述 类型 需要 默认
Accept-Language 返回数据中使用的首选语言代码。如果指定语言的翻译本不可用,则默认为英语可通过查询参数query或使用Accept-Language头来应用。
en —— 英语
zh —— 中文
ru —— 俄语
id —— 印尼语
jp —— 日语
Accepted Values: [ en,zh,ru,id,jp]
String en
Accept 响应数据格式。默认设置为application/json。可通过查询参数格式或使用Accept头来应用。
Accepted Values: [ application/json,application/xml,text/csv]
String json

查询参数

名称 描述 类型 需要 默认
lang 返回数据中将使用的首选语言代码。如果指定语言的翻译本不可用,则默认为英语可通过查询参数query或使用Accept-Language头来应用。
en—— 英语
zh—— 中文
ru—— 俄语
id—— 印尼语
jp—— 日语
Accepted Values: [ en,zh,ru,id,jp]
String en
format 响应数据格式。默认为json。可通过查询参数format 或使用Accept头来使用。
Accepted Values: [ json,xml,csv]
String json
token 访问API密钥。可通过查询参数token或使用Authorization头来使用 String
with_model_information 如果设置为True,则返回作为响应部分的模型名称 Boolean false
ignore_cache 将生成新文件 Boolean false
adjust_columns 在XLSX单元格中不调整或不换行
Accepted Values: [ no,wrap]
String no
start_date 限制将返回时间点的开始日期。 String
end_date 限制将返回时间点的结束日期。 String
count 按指定数限制返回的最新时间点的数量。 Integer
blank_observations 如果设置为真,将返回空的时间点,否则将省略这些时间点。
Accepted Values: [ filter,blank,N/A]
String filter
orientation 列/行定向
Accepted Values: [ rows,cols]
String cols
order 排序顺序 —— Asc/Desc
Accepted Values: [ asc,desc]
String asc
decimal_places 时间点值的小数位 Number 3
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.

状态码 类型 类型
200 数据模板下载信息 InsightDownloadResult
400 输入参数不正确 BadRequest
401 授权错误。 AuthorizationError
403 用户权限不正确。 PermissionsError
404 找不到请求的实体。 NotFound
408 该文档仍在生成中。请在一分钟后重复该请求。 ResponseError
415 不支持的数据格式。仅支持Only json、xml、csv。 UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 内部服务器错误。 InternalError
API查询生成器
查询
查询结果