Skip to main content
GET
Get usage by collection

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

identifier
string
required

Collection's identifier Uniquely identify a collection.

Example:

"mEFayXdO"

Query Parameters

start
string

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

Example:

"2023-07"

end
string

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

Example:

"2023-10"

Response

Monthly credits consumption of a collection.

month
string
required

Month of the usage

Example:

"2023-07"

count
integer
required

Usage count

Example:

100