CAcapy
usage

Series

Changed on
get/api/v1/usage/series

Request

  • Base URL
    https://api.capy.ai
  • Auth
    HTTP bearer

Query parameters

fromstring

Inclusive window start. Defaults to the start of the current UTC calendar month. The window reaches back at most a year before to, or 31 days for hour.

tostring

Exclusive window end. Defaults to now.

granularity'day' | 'hour'

Bucket width, in UTC. Defaults to day.

'user' | 'thread' | 'item'
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
limitstring

Rows per page, 1 to 1000. Defaults to 100.

cursorstring

Opaque page token: pass the previous page's cursor back with the same window, granularity, grouping, and filters.

Response

UsageSeriesPage

currency'USD' required

The currency of every dollar amount in the response.

fromstring required
tostring required
granularity'day' | 'hour' required
groupBystring[] required
cursorstring nullable required

Opaque page token: pass the previous page's cursor back with the same window, granularity, grouping, and filters.

Changes