API ReferenceAgents

Get Project TaskAgent Usage Report

Visible TaskAgent run counts over time for this project. Scope the report with `task_agent_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` 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 organization ID
project_idstringRequiredformat: "uuid"
The project ID

Query parameters

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

Response

Project TaskAgent usage report details retrieved successfully
project_idstringformat: "uuid"
Unique identifier of the Project.
date_rangemap from strings to strings
Time period covered by the report.
aggregationenum
Time bucket granularity used for the report.
statusenum
Run outcome filter applied to the report.
datamap from strings to integers
Visible run counts for each aggregation bucket.
total_runsinteger>=0
Total number of visible runs included in the report.

Errors

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