List deployment usage
List deployment task, DAG, and operator activity metrics, aggregated by day, week, or month. Enterprise+ tier only.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Organization to retrieve usage data for.
Query Parameters
Start of the date range (YYYY-MM-DD).
End of the date range (YYYY-MM-DD). Range must not exceed 12 months.
The granularity to aggregate by.
day, week, month Filter by workspace ID. At most 1000.
Filter by deployment ID. At most 1000.
The number of results to skip before returning values (offset mode; ignored when pageToken/pageSize is set).
x >= 0The maximum number of results to return (offset mode). Maximum: 1000.
1 <= x <= 1000Fields to sort by, formatted as <fieldName>:asc or <fieldName>:desc. Applies to offset and cursor mode.
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 Cursor page size.
1 <= x <= 1000Opaque cursor page token.
Response
OK
The list of deployment usage rows in the current page.
The maximum number of results in one page.
20
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.
The offset of the current page of results.
0
The total number of deployment usage rows matching the query.
17677