v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Analytics

List Analytics Shipments Data

Retrieve analytics shipments data.

Required authorization scope: public.analytics:read

get/2024-09/analytics/shipments

Query parameters

from_datestring required

Beginning of date. Only accept YYYY-MM-DD format.

to_datestring required

End of date. Only accept YYYY-MM-DD format.

Response

successfully returns analytics app generated data

Example response

{
  "analytics_shipments": {
    "from_date": "2023-01-01T00:00:00.000Z",
    "to_date": "2023-02-28T23:59:59.999Z"
  }
}