Developers
API referenceBusiness sign in

Schema

AnalyticsTotals

Totals for the period. Each figure counts on the business day its own event happened.

Fields

AnalyticsTotals fields
FieldTypeDescription
bookedRequiredintegerParcels booked in the period.
deliveredRequiredintegerParcels handed to the receiver (delivered or collected).
promiseMetOptionalinteger
promiseMissedOptionalinteger
onTimeRateRequirednumber or nullPromises met out of promises decided. Percent with one decimal; null when there is nothing to divide by.
averageDeliveryMinutesOptionalinteger or nullAverage minutes from booking to delivery or collection.
collectedOptionalintegerParcels collected at a Qoene Point or locker.
returnedUncollectedOptionalintegerParcels sent back because nobody collected them.
pickupRateOptionalnumber or nullCollected out of collected plus returned uncollected. Percent with one decimal; null when there is nothing to divide by.
returnedOptionalinteger
cancelledOptionalinteger
claimsFiledOptionalinteger
claimsRateOptionalnumber or nullClaims filed per parcel booked. Percent with one decimal; null when there is nothing to divide by.
returnsAuthorisedOptionalinteger
returnsRateOptionalnumber or nullReturns started per parcel delivered. Percent with one decimal; null when there is nothing to divide by.
chargeMinorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
costPerParcelMinorRequiredMinorAmount or null
overstayParcelsOptionalinteger
overstayMinorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
overstayCoveredMinorOptionalMinorAmountOverstay you covered for your customers (NB26).

Used by