Skip to main content
GET
Get monthly usage and credits per billable unit

Authorizations

X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Query Parameters

format
enum<string>

Response format. Default: json.

Available options:
csv,
json
organization_id
integer

Organization ID. Required for user sessions; ignored for organization-scoped API keys.

start_date
string<date>
required

First day of the range (YYYY-MM-DD), inclusive.

end_date
string<date>
required

Last day of the range (YYYY-MM-DD), inclusive. At most 12 calendar months after start_date.

group_by
enum<string>

Period to group by. Default: month.

Available options:
month

Response

organization_id
integer
required
start_date
string<date>
required
end_date
string<date>
required
group_by
string
required
timezone
string
required

Timezone of the month boundaries (UTC).

untyped_scheme
boolean
required

True when the organization's charges in this range weren't recorded per unit; per-unit credit rows are then null and only counts and totals apply.

old_text_pricing
boolean
required

True when text simulations are billed at a flat rate, so #Responses is null.

periods
string[]
required

Month keys (YYYY-MM) in order.

rows
object[]
required