v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Deprecated End Points

Get usage by collection

Return monthly credits consumption of a collection. Deprecated: use GET /v3/usage?organization={id}&document_type={id} instead. The new endpoint returns a unified daily series and uses the modern "document type" terminology.

get/v3/collections/{identifier}/usage

Path parameters

identifierstring required

Uniquely identify a collection.

Example:mEFayXdO

Collection's identifier

Query parameters

startstring
Example:2023-07

Start date of the period to retrieve. Format: YYYY-MM

endstring
Example:2023-10

End date of the period to retrieve. Format: YYYY-MM

Response

Monthly credits consumption of a collection.

monthstring required

Month of the usage

countinteger required

Usage count

Example response

[
  {
    "month": "2023-07",
    "count": 100
  }
]