GET
Get Usage History

Authorizations

Authorization
string
header
required

Interactive user session: the login JWT, sent as Authorization: Bearer <token>.

Query Parameters

start_date
string | null

ISO 8601 date-time string (UTC). Lower bound (inclusive) on created_at.

Example:

"2026-04-01T00:00:00Z"

end_date
string | null

ISO 8601 date-time string (UTC). Upper bound (inclusive) on created_at.

Example:

"2026-05-01T00:00:00Z"

page
integer
default:1
Required range: x >= 1
limit
integer
default:50
Required range: 1 <= x <= 100
search
string | null

Free-text search across the agent/workflow name, run name and run id.

filters
string | null

JSON-encoded array of filter objects. Each object has the shape:

Supported attribute / type / value combinations:

Unknown attributes and unsupported type values are silently ignored.

Date filtering on this endpoint is done via the dedicated start_date / end_date query params, not via a dateRange filter object.

Example:

"[{\"attribute\":\"callerNumber\",\"type\":\"text\",\"value\":{\"value\":\"415555\"}}]"

post_call_field
string | null

Filter runs whose extracted post_call_data.data contains this field. Combine with post_call_value (exact match) or post_call_value_min/post_call_value_max (numeric range). If only post_call_field is set, matches runs where the field is present with a non-null value.

post_call_value
string | null

Exact-match value for the post-call field. Booleans arrive as "true"/"false", numbers as their string form.

post_call_value_min
number | null

Inclusive lower bound for a numeric post-call field.

post_call_value_max
number | null

Inclusive upper bound for a numeric post-call field.

Response

Successful Response

runs
WorkflowRunUsageResponse ┬╖ object[]
required
total_peachdesk_tokens
number
required
total_duration_seconds
integer
required
total_count
integer
required
page
integer
required
limit
integer
required
total_pages
integer
required