Generate a usage report (PDF or JSON)
GEThttps://platform.docana.com/api/v1/usage/report/
Answers a PDF attachment, or JSON with mode=json. Accepts a start/end day range (or the legacy year/month pair), an optional CSV of application ids and a mode of detailed (default), summary or json. The JSON mode carries the same totals as the PDF: quantity per metered unit, the per-application pivot and the raw events, for automation. For the current month budget position use getUsage instead.
Request
Responses
- 200
- 400
- 401
- 403
- 500
The usage report as an application/pdf attachment. With mode=json the same numbers come back as JSON: period (start, end as YYYY-MM-DD), totals (quantity per metered unit, each event counted once), applications (id, name, and per-unit totals for each application; an event shared by several applications counts once in each) and events (sku, quantity, occurredAt, applicationIds, entityId, oldest first).
The request body, query, or path failed validation. See validationErrors.
The API key or session is missing, expired, or malformed.
The caller is authenticated but not allowed to perform this operation.
Unexpected server error.