Developers
API referenceBusiness sign in

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

AnalyticsSummary fields
FieldTypeDescription
environmentRequiredEnvironmentThe key environment. TEST never touches live custody, payments, dispatch or notifications.
marketRequiredstring
currencyRequiredstring
fromRequiredstring (date)
toRequiredstring (date)
refreshedAtOptionalstring (date-time) or nullWhen the daily figures were last rebuilt (hourly).
totalsRequiredAnalyticsTotalsTotals for the period. Each figure counts on the business day its own event happened.
trendRequiredarray of AnalyticsTrendDayOne entry per business day in the period.
byProductRequiredarray of AnalyticsBreakdown
byRegionRequiredarray of AnalyticsBreakdown
topDestinationsRequiredarray of objectUp to 10 destination regions by parcels booked.
regionRequiredstring
parcelsRequiredinteger

Used by