Get Usage History
Changed onGet paginated workflow runs with usage for the organization.
Request
- Base URLhttps://app.dograh.com
- URLhttps://app.dograh.com/api/v1/organizations/usage/runs
- Authnone declared
Query parameters
ISO 8601 date-time string (UTC). Lower bound (inclusive) on created_at.
ISO 8601 date-time string (UTC). Upper bound (inclusive) on created_at.
JSON-encoded array of filter objects. Each object has the shape:
{ "attribute": "<name>", "type": "<type>", "value": <value> }
Supported attribute / type / value combinations:
| attribute | type | value shape | matches |
|---|---|---|---|
| runId | number | { "value": 12345 } | exact run id |
| workflowId | number | { "value": 42 } | exact agent (workflow) id |
| campaignId | number | { "value": 7 } | exact campaign id |
| callerNumber | text | { "value": "415555" } | substring match on initial_context.caller_number |
| calledNumber | text | { "value": "9911848" } | substring match on initial_context.called_number |
| dispositionCode | multiSelect | { "codes": ["XFER", "DNC"] } | any of the codes in gathered_context.mapped_call_disposition |
| duration | numberRange | { "min": 60, "max": 300 } | call duration (seconds), inclusive bounds |
| callDirection | radio | { "status": "inbound" } | inbound or outbound; any other value matches all |
| callChannel | radio | { "status": "telephony" } | telephony, web, or chat — the group of run modes for that channel |
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.
Field to sort by ('duration'). Defaults to created_at.
Sort order ('asc' or 'desc').
Headers
Response
Successful Response
Changes
- info
added the new optional
headerrequest parameterX-API-Key - info
added the new optional
headerrequest parameterauthorization - info
added the new optional
queryrequest parametersort_by - info
added the new optional
queryrequest parametersort_order - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the success response with the status
- info