v1

latestOpenAPI 3.1.02026-07-265094114.0 KB
Usage

Retrieve API usage

Retrieve API usage statistics for your workspace. Note that the statistics returned are for content generation requests only (e.g Run command or Run template).

get/v1/usage

Query parameters

startstring required
Example:2023-06-01T00:00:00.000Z

Start date for usage data

endstring required
Example:2023-06-07T00:00:00.000Z

End date for usage data

granularity'week' | 'day' | 'hour' required
Example:day

Bucket size for usage data

Response

Retrieved API usage.

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "usage",
  "data": {
    "requests": [
      {
        "t": "2023-09-11T13:28:59.318Z",
        "v": 83
      },
      {
        "t": "2023-09-11T14:28:59.318Z",
        "v": 173
      },
      {
        "t": "2023-09-11T15:28:59.318Z",
        "v": 162
      }
    ]
  }
}