reports

Get Monthly Series

Return km and deliveries per month for a trailing window, oldest first.

Backs the homepage statistics bar charts, which need a whole series at once rather than one request per bar.

get/api/reports/monthly-series

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

monthsinteger

How many months to return, counting back from the end month

end_yearinteger nullable

Year of the newest month; defaults to the current month

end_monthinteger nullable

Month of the newest month (1-12)

Response

Successful Response

monthinteger required
total_deliveriesinteger required
total_kmnumber required
yearinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.