高级参数

API 支持多种高级参数，让您能够对数据进行更细粒度的过滤和排序。

1. 包含成员

参数 include 允许您指定在计算指标时应考虑的维度的唯一成员。用户可以指定一个或多个要包含的成员，用逗号 (,) 分隔。格式如下：

&include=<level_name>:<member_key>,<member_key>,<member_key>

您可以在请求中指定一个或多个 include 参数，可以在不同的键中，也可以在同一个键中用分号 (;) 分隔。

&include=<level1>:<level1_member1>&include=<level2>:<level2_member1>,<level2_member2>
&include=<level1>:<level1_member1>;<level2>:<level2_member1>,<level2_member2>

例如，以下 API 调用将仅包含 2020 年和产品代码为第 1 节 HS2 05 的数据：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=HS2&measures=Trade+Value&include=HS2:105;Year:2020

2. 排除成员

与 include 指定的唯一成员相同，exclude 参数指定所有可用成员，除了提到的成员，应在聚合中考虑。格式相同：

&exclude=<level1>:<level1_member1>&exclude=<level2>:<level2_member1>,<level2_member2>
&exclude=<level1>:<level1_member1>;<level2>:<level2_member1>,<level2_member2>

例如，以下 API 调用将返回所有可用产品的数据，除了产品代码为第 1 节 HS2 05 的数据：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=HS2&measures=Trade+Value&exclude=HS2:105

3. Parents（父项）

parents 参数允许您在层级维度中包含父级成员。您可以指定要包含父项的特定层级，也可以使用布尔值以包含所有父项。格式如下：

&parents=<level1>,<level2>
&parents=true

例如，以下 API 调用在查询美国出口数据时，将包含 HS4 级别（例如 Section 和 HS2）的父级成员：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=HS4,Exporter+Country&measures=Trade+Value,Quantity&parents=HS4

4. Filters（过滤）

filters 参数允许您基于度量值使用各种比较运算符过滤结果。基本格式为：

&filters=<measure>.<operation>

空值操作

您可以使用以下方式过滤空值或非空值：

&filters=Trade+Value.isnull
&filters=Trade+Value.isnotnull

比较操作

支持以下比较操作：

gt – 大于 (>)
gte – 大于等于 (>=)
lt – 小于 (<)
lte – 小于等于 (<=)
eq – 等于 (==)
neq – 不等于 (!=)

例如，要过滤贸易值大于 8000 亿美元的数据：

&filters=Trade+Value.gt.800000000000

您也可以使用 .and./.or. 组合多个条件。例如，要过滤贸易值在 250,000 和 750,000 之间的数据：

&filters=Trade+Value.gt.250000.and.lt.750000

5. 排名与排序

API 提供两种参数用于对结果进行排序：ranking 和 sort。

Ranking（排名）

ranking 参数允许您根据某个度量对结果进行排名。您可以指定带可选减号的度量名称以获得降序，或使用布尔值。格式如下：

&ranking=<measure>
&ranking=-<measure>
&ranking=<measure1>,-<measure2>
&ranking=true

Sort（排序）

sort 参数允许您按度量或维度对结果进行排序，可指定升序或降序。格式如下：

&sort=<measure or level>.asc
&sort=<measure or level>.desc

例如，按 Trade Value 升序排序贸易数据：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=Year,HS4&measures=Trade+Value,Quantity&include=Year:2021&sort=Trade+Value.asc&ranking=Trade+Value

或获取贸易值超过 8000 亿美元的顶级出口国，并按年份排序：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=Exporter+Country,Year&measures=Trade+Value&locale=zh&filters=Trade+Value.gt.800000000000&sort=Year.desc

6. TopK（前 K）

top 参数允许您获取每个指定维度组合的前 N 条记录，按度量或维度排序。格式如下：

&top=<amount>.<level1>[,<level2>].<measure or level>.<order>

例如，要获取每个国家贸易值最高的年份：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=Exporter+Country,Year&measures=Trade+Value&locale=zh&top=1.Exporter+Country.Trade+Value.desc

或获取每个国家贸易值最高的两个年份：

https://api-v2.oec.world/tesseract/data.jsonrecords?cube=trade_i_baci_a_96&drilldowns=Exporter+Country,Year&measures=Trade+Value&locale=zh&include=Year:2020,2021,2022&top=2.Exporter+Country.Trade+Value.desc

⚠️ 注意： 参数中提到的所有列必须是请求的一部分，无论是在 drilldowns 还是 measures 中。

7. Time（时间）

time 参数为基于时间的维度提供特殊过滤功能，支持两种主要格式：

Latest/Oldest（最新/最旧）格式

此格式允许您获取数据集中可用的最新或最旧数据点：

&time=<dimension>.latest[.amount]
&time=<dimension>.oldest[.amount]

Trailing/Leading（滞后/领先）格式

此格式允许您设置相对于数据集中可用的最新/最旧记录的时间范围。与 latest/oldest 格式类似，但严格基于时间：

&time=<dimension>.trailing[.amount]
&time=<dimension>.leading[.amount]

响应

国际贸易数据示例