Dashboard

Get comprehensive order metrics

Changed on

Get all key order metrics: Average Order Value, Multiple Document Ratio, Fast Track Ratio, and Paper Copy Ratio

get/dashboard/order-metrics

Request

Query parameters

startDatestring
Example:2026-01-01

Start date for filtering (ISO 8601 format)

endDatestring
Example:2026-01-13

End date for filtering (ISO 8601 format)

utmSourcestring
Example:google

Optional UTM source filter (exact match after TRIM). Use "notSet" for orders with no UTM source (NULL, empty, or whitespace).

Response

Order metrics retrieved successfully

totalOrdersnumber required

Total orders in the date range

extraDocumentOrdersnumber required

Orders whose customer was sent more documents than their document products, counted on the day the extra documents were sent

byOSobject required

Order counts grouped by Operating System

Changes