See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.
Download Usage Runs Report
GET /api/v1/organizations/usage/runs/report — request parameters and responses from the Menace Voice API schema.
2 min read
get/api/v1/organizations/usage/runs/report
Request example
Response
get/api/v1/organizations/usage/runs/report
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:
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.
Headers
Responses
application/json
Successful Response