Returns one performance metric for one location over a date range, scoped to your organization.
Supported namespaces are unlocode, country, continent, region, and smdg. Supported metrics are import_dwell, export_dwell, berth_time, arrival_to_berth, import_teu, export_teu, and average_delay; unit in the response is teu for the two TEU metrics and days for the rest.
An empty data[] means there was no measurement for this location and metric in the requested window — it is not an error. Coverage reflects locations with observed activity in the requested window and is not a fixed list.
Terminal locations (the smdg namespace) are not supported and return a 422 with code: "unsupported_location_type". Depot and rail locations are not addressable through this endpoint at all. Industry benchmark comparisons are not currently exposed by this endpoint.
A 403 is returned when Performance is not enabled for your organization. A 404 is returned for an unknown namespace (code: "unknown_namespace") or an unknown location code (code: "unknown_location"). A 422 is returned for an unknown metric (code: "unknown_metric"), an unsupported location type (code: "unsupported_location_type"), or a query parameter that fails validation. Switch on code rather than on the message text — the two 404 cases are distinguishable only by it.
start and end are both required and there is no cap on how far apart they may be. A very wide window does not return more rows — it returns the same single row over a longer period — but it does take longer to compute, and may time out.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||