GET /insights/{id}/series

特殊数据模板的所有数列列表。

返回自指定数据模板中的所有数列,包括所有时间点和元数据,以及其在数据模板上下文中的布局,用分组项和分隔符表示。

路径参数

名称 描述 类型 需要 默认
id 数据模板ID String

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]
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]
String json
token 访问API密钥。可通过查询参数token或使用Authorization头来使用 String
with_model_information 如果设置为True,则返回作为响应部分的模型名称 Boolean false
count 按指定数限制返回的最新时间点的数量。 Integer 3650
start_date 限制将返回时间点的开始日期。 String
end_date 限制将返回时间点的结束日期。 String
updated_after 仅返回指定日期之后的更新时间点。 String
blank_observations 如果设置为True,则返回空时间点 Boolean false
time_points_status 时间点筛选器。一个或多个用逗号分隔的状态代码值。未显式设置时,默认为T。
T——激活
X——删除
Accepted Values: [ active,deleted]
String active
with_replacements_metadata 如果为真,结果将包含替换元数据,而不仅仅是ID列表 Boolean false
forecast_only 如果为真,结果将仅包含带有预测的数列 Boolean false
with_release_only 如果为真,结果将仅包含带有发布进度的数列 Boolean false
with_replacements_only 如果为真,结果将仅包含带有建议的数列 Boolean false
with_observations_only If it is true result will not contain series without observations Boolean false
with_continuous_only If set to true results will contain only series with available historical extensions Boolean false
limit 要返回的记录数,范围为1-100。默认为100。 Number 100
offset 从中返回记录的偏移量。用于在达到极限时获取下一个记录集。 Number 0

响应

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 数据模板数列列表 InsightSeriesPaginatedResult
400 输入参数不正确 BadRequest
401 授权错误。 AuthorizationError
403 用户权限不正确。 PermissionsError
404 找不到请求的实体。 NotFound
415 不支持的数据格式。仅支持Only json、xml、csv。 UnsupportedMedia
429 Too many requests were send or limit exceeded. TooManyRequests
500 内部服务器错误。 InternalError
API查询生成器
查询
查询结果