API ReferenceTasksTasks

Get Project Task Usage Report

Visible Task run counts over time for this project. Scope the report with `task_id` and `status` (`ALL`, `SUCCESS` or `FAIL`). Unlike the timing report this endpoint has no `start_date`/`end_date`: the window is always relative to now, and `aggregation` chooses it — `day` (the default) returns the last 24 hours in hourly buckets, `week` returns the last seven days in daily buckets. `data` maps each bucket to a run count and contains every bucket in the window, including empty ones. `total_runs` is the sum across the window.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The unique identifier of the organization.
project_idstringRequiredformat: "uuid"
The unique identifier of the project.

Query parameters

task_idstring or nullOptionalformat: "uuid"
Filter to a specific task
aggregationenumOptionalDefaults to day
Time bucket granularity. Can be either 'day' or 'week'.
Allowed values:
statusenumOptional
Run outcome filter. Can be ALL, SUCCESS, or FAIL.
Allowed values:

Response

Project Task usage report details retrieved successfully
project_idstringformat: "uuid"
The unique identifier of the Project.
date_rangemap from strings to nullable strings
The time range for the report, with start and end timestamps.
aggregationenum
The time interval for data aggregation.
statusenum
Run outcome filter applied to this usage report.
datamap from strings to integers

Visible task-run counts for each aggregation bucket.

total_runsinteger
Total visible task runs across the reporting window.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error