API ReferenceTasksTasks

Fetch Credit Report

Retrieve aggregate credit usage statistics for a specific task. This report returns: - Total `charged_credits` across the filtered time range - A per-revision credit breakdown - Optional segmentation by reporting group Credit reports are limited to a maximum 3-month lookback window. If `start_date` is omitted, the report defaults to the earliest permitted date.

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.
task_idstringRequiredformat: "uuid"
The specific Task to reference.

Query parameters

start_datestring or nullOptional

Start date for the report (e.g., ‘2023-06-01’, ‘24 hours ago’, ‘yesterday’).

end_datestring or nullOptional

End date for the report (e.g., ‘2023-06-30’, ‘now’, ‘today’).

show_reporting_groupbooleanOptionalDefaults to false
If true, include reporting group in the report.

Response

Successfully retrieved credit usage report
task_idstringformat: "uuid"
The unique identifier of the Task.
task_revisionslist of objects
Timing data broken down by task revision, showing performance metrics for each active revision.
total_creditsstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
Total credits charged for the Task.
total_task_runsinteger
Total number of task runs for each time interval.
date_rangemap from strings to nullable strings
The time range for the report, with start and end timestamps.

Errors

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