Read voice usage for domain

GET

/domains/{domain}/voice-usage

Last modified:2026-10-12 18:08:01

OperationId:ReadVoiceUsageForDomain

Returns aggregated voice service usage across the platform for a time window. Requires Reseller or Super User scope, because the report is not confined to a single domain. Provide the window as from and to Unix timestamps; both are required. Narrow the result with the optional domain, service_type, vendor, reseller, and group_by filters. A domain of * is treated as no domain filter. Omitting from or to returns 400. The usage data is produced by the voice usage middleware, so an upstream outage is reported with the upstream status, or 502 when the middleware cannot be reached. To scope the same report to one domain, call GET /domains/{domain}/voice-usage. This is the domain-scoped form: the report is confined to {domain} through the access-control object, so an Office Manager or higher within that domain may call it.

Request

Path Params

Query Params

Responses

🟢200

application/json

Voice usage report.

Bodyapplication/json

🟠400Err400

🟠401Err401

🟠403Err403

🟠405Err405

🔴502Err502

Request Example

Shell

JavaScript

Java

Swift

curl --location '/domains/acme.example.com/voice-usage?from=1756684800&to=1759363200&domain=acme.example.com&service_type=transcription&vendor=deepgram&reseller=example-reseller&group_by=service_type'

Response Example

200 - Success Example

{
    "from": 1756684800,
    "to": 1759363200,
    "group_by": "service_type",
    "results": [
        {
            "service_type": "transcription",
            "vendor": "deepgram",
            "units": 48213,
            "cost": 192.85
        },
        {
            "service_type": "text-to-speech",
            "vendor": "google-wavenet",
            "units": 10422,
            "cost": 41.69
        }
    ]
}

Modified at 2026-10-12 18:08:01

Read voice usage

Read voice usage summary