Usage breakdown by operation

GEThttps://api.veriko.mx/v1/usage/breakdown

Audience: public
Auth: API key
Permission: usage:read_self

Breaks down usage for the indicated period by billable operation type (validation, validation_ocr, etc.). Use current for the running month or YYYY-MM for a specific month.

Parameters
Parameter	In	Type	Required	Description
`period`	query	`string`	optional	Period to break down. Accepts `current` for the running month or a `YYYY-MM` string for a specific month. e.g. `current`

Request

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/usage/breakdown' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response status codes**`GET /v1/usage/breakdown`
Status	Class	Description	Body
200	`2xx`	Consumption counts by operation type for the requested period.	No body
400	`4xx`	The `period` parameter format is invalid.	`ErrorResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`

**Errors from `GET /v1/usage/breakdown`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b9`
403	`forbidden`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c0`