API ReferenceTask Agents

Fetch Task Agent Usage Report

Retrieve Task Agent run counts over time. This report includes: - Run counts grouped by time bucket - Optional filtering to error runs only - Total run count across the reporting window Defaults: - `aggregation=day` returns the last 24 hours in hourly buckets - `aggregation=week` returns the last 7 days in daily buckets

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path parameters

org_idstringRequiredformat: "uuid"
The organization ID
project_idstringRequiredformat: "uuid"
The project ID
task_agent_idstringRequiredformat: "uuid"
The task agent ID

Query parameters

aggregationenumOptionalDefaults to day
The aggregation level for the report. Can be either 'day' or 'week'.
Allowed values:
statusenumOptional
Run outcome filter for the report. Can be ALL, SUCCESS, or FAIL.
Allowed values:
errors_onlybooleanOptionalDefaults to false
If true, only include runs with errors in the report

Response

Task Agent usage report
task_agent_idstringformat: "uuid"
Unique identifier of the TaskAgent.
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
Run counts for each aggregation bucket.
total_runsinteger>=0
Total number of 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