GET/v1/analytics/summary

Counters and daily series

Items by status, QR scans and spend for a period (from and to as dates, or days back, default thirty) and optionally one Postflow or Postbatch, with a row per day.

Scope items.read

Query parameters

fromdate

todate

daysintegermin 1max 366

postflowIdstringmax length 40

postbatchIdstringmax length 40

Returns

5 fields of the 200 answer

periodobjectrequired

2 fields

fromdaterequired

todaterequired

filterobjectrequired

2 fields

postflowIdstring

postbatchIdstring

totalsobjectrequired

10 fields

createdintegerrequired

sentintegerrequired

scheduledintegerrequired

heldintegerrequired

needsAttentionintegerrequired

cancelledintegerrequired

failedintegerrequired

suppressedintegerrequired

scansintegerrequired

spendCentsintegerrequired

byStatusobjectrequired

dailyarray of objectsrequired

7 fields

daydaterequired

createdintegerrequired

sentintegerrequired

cancelledintegerrequired

failedintegerrequired

scansintegerrequired

spendCentsintegerrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

{ "period": { "from": "2026-11-02", "to": "2026-11-02" }, "filter": { "postflowId": "pf_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "postbatchId": "pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K" }, "totals": { "created": 1, "sent": 1, "scheduled": 1, "held": 1, "needsAttention": 1, "cancelled": 1, "failed": 1, "suppressed": 1, "scans": 1, "spendCents": 1250 }, "byStatus": { "key": 1 }, "daily": [ { "day": "2026-11-02", "created": 1, "sent": 1, "cancelled": 1, "failed": 1, "scans": 1, "spendCents": 1250 } ] }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }