Get a call insights

Use this endpoint to to retrieve media and signalling insights of a voice call.

Get channel call insights

get

Get a channel call insights

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Responses

200

OK

application/json

idstring · uuidRequired

channelIdstring · uuidRequired

fromstringRequired

tostringRequired

parentIdstring · uuidOptional

directionstring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

durationintegerOptional

hangupCauseCodeintegerOptional

hangupSourcestring · enum · nullableOptionalPossible values:

hangupSipCodestringOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

ringingAtstring · date-timeOptional

answeredAtstring · date-timeOptional

endedAtstring · date-timeOptional

404

The request did not pass validation

application/json

get

/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "from": "text",
  "to": "text",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "incoming",
  "status": "accepted",
  "type": "pstn",
  "duration": 1,
  "hangupCauseCode": 1,
  "hangupSource": "callee",
  "hangupSipCode": "text",
  "createdAt": "2026-03-06T17:59:48.149Z",
  "updatedAt": "2026-03-06T17:59:48.149Z",
  "ringingAt": "2026-03-06T17:59:48.149Z",
  "answeredAt": "2026-03-06T17:59:48.149Z",
  "endedAt": "2026-03-06T17:59:48.149Z",
  "signallingMetrics": {
    "pdd": 1,
    "edgeRegion": "text",
    "providerName": "text",
    "userAgent": "text",
    "remoteSignallingIp": "text",
    "remoteMediaIp": "text"
  },
  "mediaMetrics": {
    "mos": 1,
    "qualityScore": 1,
    "inBytes": 1,
    "outBytes": 1,
    "inPacketCount": 1,
    "outPacketCount": 1,
    "inMediaPacketCount": 1,
    "outMediaPacketCount": 1,
    "inDtmfPacketCount": 1,
    "outDtmfPacketCount": 1,
    "jitterMinVar": 1,
    "jitterMaxVar": 1,
    "jitterLossRate": 1,
    "jitterBurstRate": 1,
    "meanInterval": 1,
    "flawTotal": 1,
    "readCodecName": "text",
    "readCodecRate": "text",
    "writeCodecName": "text",
    "writeCodecRate": "text",
    "dtmfType": "text"
  }
}

Example 1: Get insights from an outbound call

Request Headers

curl "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"

Request Body

Response