Schema
AnalyticsSummary
Delivery performance of your own parcels. Only your Business; no receiver names, phones or addresses. TEST and LIVE keys read the same LIVE figures (read-only aggregates).
Fields
| Field | Type | Description |
|---|---|---|
environmentRequired | Environment | The key environment. TEST never touches live custody, payments, dispatch or notifications. |
marketRequired | string | |
currencyRequired | string | |
fromRequired | string (date) | |
toRequired | string (date) | |
refreshedAtOptional | string (date-time) or null | When the daily figures were last rebuilt (hourly). |
totalsRequired | AnalyticsTotals | Totals for the period. Each figure counts on the business day its own event happened. |
trendRequired | array of AnalyticsTrendDay | One entry per business day in the period. |
byProductRequired | array of AnalyticsBreakdown | |
byRegionRequired | array of AnalyticsBreakdown | |
topDestinationsRequired | array of object | Up to 10 destination regions by parcels booked. |
regionRequired | string | |
parcelsRequired | integer |