Call counts by state, outcome and direction

GEThttps://server.heyrik.com/api/v1/calls/stats

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 6 properties

totalnumber

Example 412

connectednumber

Example 355

disconnectednumber

Example 33

byStateobject

Explore 2 properties

ENDEDnumber

Example 388

FAILEDnumber

Example 24

byOutcomeobject

Explore 2 properties

resolvednumber

Example 240

callbacknumber

Example 88

byDirectionobject

Explore 2 properties

inboundnumber

Example 210

outboundnumber

Example 202

Error reference

GET/calls/stats

cURL

curl https://server.heyrik.com/api/v1/calls/stats \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "total": 412,
    "connected": 355,
    "disconnected": 33,
    "byState": { "ENDED": 388, "FAILED": 24 },
    "byOutcome": { "resolved": 240, "callback": 88 },
    "byDirection": { "inbound": 210, "outbound": 202 }
  }
}

Illustrative examples · No live request is sent