Skip to main content

Refinements

Refinement endpoints allow for a convenient method of exploring top-values for multiple fields against a specific search criteria.

In this example, for shipments that contain clothing, find the top origin countries, destination countries, and unlading ports.

{
  "data_source": "global",
  "query": {
    "text": "clothing"
  },
  "fields": ["destination_countries", "origin_countries", "port_unlading_name"]
}

Refinements Schema​

Selected Data-Source
string

Choose the desired data-source to view the available fields

refinement-fields
Array of strings
Items Enum: "data_source" "trade_direction" "transport_type" "bol_type" "financial_countries" "origin_countries" "destination_countries" "shipment_month" "shipment_year" "gics_code" "us_export_type" "port_lading_name" "port_lading_country" "port_lading_un_locode" "port_lading_coast" "port_unlading_name" "port_unlading_country" "port_unlading_un_locode" "port_unlading_coast" "port_destination_name" "port_destination_country" "port_destination_un_locode" "consignee_country" "consignee_region" "consignee_region_2" "consignee_region_3" "consignee_simple_industry" "consignee_trade_roles" "consignee_data_available" "shipper_country" "shipper_region" "shipper_region_2" "shipper_region_3" "shipper_simple_industry" "shipper_trade_roles" "shipper_data_available"