Developers
API referenceBusiness sign in

Analytics

Your delivery performance

GET/analytics/summary

Scope analytics.read

Volume trend, on-time rate, delivery time by product and region, returns and claims rates, cost per parcel, overstay you covered and top destinations, for your own parcels. Figures are rebuilt hourly from daily aggregates in the market time zone (Africa/Accra for Ghana). The period defaults to the last 30 days and is at most 366 days.

Request

Query parameters

Query parameters
NameInTypeDescription
fromOptionalquerystringFirst business day (YYYY-MM-DD). Default 29 days before to.
toOptionalquerystringLast business day (YYYY-MM-DD). Default today in the market.

Response

Success responses
StatusMeaning
200Your figures

The body is { "status": "success", "data": … }. Fields of data (AnalyticsSummary):

Response data
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

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
400The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed.
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.