Get an import breakdown
Get nested totals with subtotals at every level of a dimension hierarchy such as region, country, and port, or HS chapter and heading.
Authorizations
Use a Terminal49 API key in the Authorization header with the Token prefix.
Authorization: Token YOUR_API_KEY
Body
Hierarchy, outermost first, for example ["origin_region", "origin_country", "pod"] or ["hs2", "hs4"].
1 - 3 elementsA dimension to group or break down by. pod is the US port of discharge, pol the foreign port of lading, pod_coast is EAST, WEST, or GULF, dest_state is the destination US state, company_state the importer's state, hs2 and hs4 are HS chapter and heading codes, and reefer splits refrigerated from dry containers.
carrier, scac, origin_country, origin_region, pod, pod_coast, dest_state, reefer, pol, pol_country, container_type, company, company_state, hs4, hs2 What to measure. containers counts physical containers (each box once). teus sums twenty-foot equivalent units. estimated_value sums modelled USD estimates, not declared customs values.
containers, teus, estimated_value Filters for trends and breakdown. Name-like fields match case-insensitive substrings; codes (hs4, hs2, pod_coast, states, scac) match exactly. Omit a field to leave it unfiltered.
First month, YYYY-MM inclusive. Defaults to 12 months ago.
^\d{4}-(0[1-9]|1[0-2])$"2025-10"
Last month, YYYY-MM inclusive. Defaults to the current, partial month.
^\d{4}-(0[1-9]|1[0-2])$"2026-09"
Top N children under each parent.
1 <= x <= 50Response
OK
What to measure. containers counts physical containers (each box once). teus sums twenty-foot equivalent units. estimated_value sums modelled USD estimates, not declared customs values.
containers, teus, estimated_value The hierarchy, outermost first.
A dimension to group or break down by. pod is the US port of discharge, pol the foreign port of lading, pod_coast is EAST, WEST, or GULF, dest_state is the destination US state, company_state the importer's state, hs2 and hs4 are HS chapter and heading codes, and reefer splits refrigerated from dry containers.
carrier, scac, origin_country, origin_region, pod, pod_coast, dest_state, reefer, pol, pol_country, container_type, company, company_state, hs4, hs2 Filters for trends and breakdown. Name-like fields match case-insensitive substrings; codes (hs4, hs2, pod_coast, states, scac) match exactly. Omit a field to leave it unfiltered.
First month (inclusive).
"2025-10"
Last month (inclusive).
"2026-10"
Name of the fact table the rollup was computed from.
Counting caveats that apply to this response, for example that volume is physical containers or that the window includes a partial month. Surface these to end users.
Grand total first, then subtotals per level, keeping the top N children under each parent.