Skip to main content
GET
List deployment usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to retrieve usage data for.

Query Parameters

startDate
string
required

Start of the date range (YYYY-MM-DD).

endDate
string
required

End of the date range (YYYY-MM-DD). Range must not exceed 12 months.

timeGrain
enum<string>
default:day

The granularity to aggregate by.

Available options:
day,
week,
month
workspaceId
string[]

Filter by workspace ID. At most 1000.

deploymentId
string[]

Filter by deployment ID. At most 1000.

offset
integer
default:0

The number of results to skip before returning values (offset mode; ignored when pageToken/pageSize is set).

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return (offset mode). Maximum: 1000.

Required range: 1 <= x <= 1000
sorts
enum<string>[]

Fields to sort by, formatted as <fieldName>:asc or <fieldName>:desc. Applies to offset and cursor mode.

Available options:
id:asc,
id:desc,
date:asc,
date:desc,
timeGrain:asc,
timeGrain:desc,
organizationId:asc,
organizationId:desc,
workspaceId:asc,
workspaceId:desc,
deploymentId:asc,
deploymentId:desc,
taskSuccessCount:asc,
taskSuccessCount:desc,
taskFailureCount:asc,
taskFailureCount:desc,
taskTotalCount:asc,
taskTotalCount:desc,
distinctDagCount:asc,
distinctDagCount:desc,
distinctOperatorCount:asc,
distinctOperatorCount:desc
pageSize
integer

Cursor page size.

Required range: 1 <= x <= 1000
pageToken
string

Opaque cursor page token.

Response

OK

items
object[]
required

The list of deployment usage rows in the current page.

limit
integer
required

The maximum number of results in one page.

Example:

20

nextPageToken
string
required

Cursor mode (AIP-158) fields. NextPageToken is empty string on the last page (per spec — do not use omitempty). PageSize echoes the effective page size when the caller opted into cursor mode.

offset
integer
required

The offset of the current page of results.

Example:

0

pageSize
integer
required
previousPageToken
string
required
totalCount
integer
required

The total number of deployment usage rows matching the query.

Example:

17677