Parámetros avanzados

Parámetros avanzados

La API admite varios parámetros avanzados que te permiten filtrar y ordenar los datos.

1. Incluir miembros

El parámetro include te permite especificar los únicos miembros de una dimensión que deben ser considerados al momento de calcular las métricas. Los usuarios pueden especificar uno o más miembros a incluir separados por comas (,). El formato es el siguiente:

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

Puedes especificar uno o varios parámetros include en la petición, tanto en distintas claves, como en la misma clave separados por punto y coma (;).

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

Por ejemplo, la siguiente llamada a la API incluirá datos sólo para el año 2020 y para el código de productos de la Sección 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. Excluir miembros

De la misma manera que include especifica los únicos miembros que deben ser considerados, el parámetro exclude especifica que todos los miembros disponibles excepto los mencionados deben ser considerados en la agregación. El formato es el mismo:

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

Por ejemplo, la siguiente llamada a la API traerá datos para todos los productos disponibles excepto para el código de producto Sección 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

El parámetro parents te permite incluir miembros padre en dimensiones jerárquicas. Puedes especificar niveles concretos para incluir padres o usar un valor booleano para incluir todos los padres. El formato es el siguiente:

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

Por ejemplo, la siguiente llamada a la API incluirá miembros padre para el nivel HS4 (p. ej., Section y HS2) al consultar datos de exportación de EE. UU.:

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

El parámetro filters te permite filtrar resultados basados en valores de medida usando varias operaciones de comparación. El formato básico es:

&filters=<measure>.<operation>

Operaciones nulas

Puedes filtrar valores nulos o no nulos usando:

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

Operaciones de comparación

Se admiten las siguientes operaciones de comparación:

• gt – Mayor que (>)
• gte – Mayor o igual que (>=)
• lt – Menor que (<)
• lte – Menor o igual que (<=)
• eq – Igual a (==)
• neq – Distinto a (!=)

Por ejemplo, para filtrar valores de comercio mayores a 800 mil millones USD:

&filters=Trade+Value.gt.800000000000

También puedes combinar múltiples condiciones usando .and./.or.. Por ejemplo, para filtrar valores de comercio entre 250,000 y 750,000:

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

5. Ranking y ordenación

La API ofrece dos parámetros para ordenar los resultados: ranking y sort.

Ranking

El parámetro ranking te permite clasificar los resultados basados en una medida. Puedes especificar el nombre de la medida con un signo menos opcional para orden descendente, o usar un valor booleano. El formato es:

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

Sort

El parámetro sort te permite ordenar los resultados por una medida o un nivel (dimensión). Puedes especificar orden ascendente o descendente. El formato es:

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

Por ejemplo, para ordenar los datos de comercio por Trade Value en orden ascendente:

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

O, para obtener los principales exportadores por encima de un umbral de 800 mil millones USD ordenados por año:

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

6. TopK

El parámetro TopK te permite obtener los N registros principales para cada combinación única de niveles especificados, ordenados por una medida o nivel. El formato es:

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

Por ejemplo, para obtener el año con el valor comercial más alto para cada país:

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

O, para obtener los 2 años con los valores comerciales más altos para cada país:

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

⚠️ Nota: Todas las columnas mencionadas en el parámetro deben ser parte de la petición, ya sea en drilldowns o measures.

7. Time

El parámetro time ofrece capacidades de filtrado especiales para dimensiones basadas en tiempo. Admite dos formatos principales:

Formato Latest/Oldest

Este formato te permite obtener los puntos de datos más recientes o más antiguos disponibles en el conjunto de datos:

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

Formato Trailing/Leading

Este formato te permite fijar un rango de tiempo a partir del registro más reciente o más antiguo disponibles en el conjunto de datos. Funciona de modo similar al formato latest/oldest, pero es estrictamente basado en el tiempo:

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