usage

Summarize usage

Read metered usage by agent, run or day. Use purpose=test for usage that is measured but not billed, and check completeness.

get/api/v1/usage

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/usage
  • Auth: HTTP bearer

Query parameters

cursorstring
limitinteger
group_by'agent' | 'run' | 'day' required
fromstring date-time required
tostring date-time required
agent_idstring
purpose'billable' | 'test'

billable: non-test runs (the billable report); test: test runs, metered and not billed

Response

Summarize metered usage by agent, run or day: the billable runs, or (purpose=test) the test runs, metered and not billed

group_by'agent' | 'run' | 'day' required
purpose'billable' | 'test' required
completeness'complete' | 'partial' required
next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.