GET
/
usage
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/usage \
  --header 'authorization: <authorization>' \
  --header 'x-organization-id: <x-organization-id>'
[
  {
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "calls": 123,
    "minutes": 123
  }
]

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

​
x-organization-id
string
required

The organization ID to use for the request. Required if your user is associated to more than one organization.

Query Parameters

​
start
string

The start date to filter usages by. Defaults to all usages.

Example:

"2024-01-01T00:00:00.000Z"

​
end
string

The end date to filter usages by. Defaults to all usages.

Example:

"2024-01-01T00:00:00.000Z"

Response

200
application/json
200
​
org_id
string
required
​
use_case_id
string
required
​
start
string
required
​
end
string
required
​
calls
number
required
​
minutes
number
required

Was this page helpful?