API referenceGet call insights

Analytics

Get call insights

Returns call analytics for a time range: totals by call type, connected and not connected calls, average duration, who ended the call, callers who hung up early, the agent's response time, and daily, status, hourly and day-by-hour (heatmap) breakdowns.

POST

https://api.nabrah.ai/api/ext/insights/voice

Get call insights

curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/insights/voice' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start": "2026-11-01T00:00:00+03:00",
  "end": "2026-11-12T23:59:59+03:00",
  "tz": "Asia/Riyadh"
}'

{
  "totals": {
    "total": 0,
    "inbound": 0,
    "outbound": 0,
    "web": 0
  },
  "connected": 0,
  "not_connected": {
    "no_answer": 0,
    "busy": 0,
    "failed": 0
  },
  "avg_duration_seconds": 0,
  "ended_by": {
    "customer": 0,
    "agent": 0,
    "no_response": 0,
    "time_limit": 0,
    "voicemail": 0,
    "transfer": 0,
    "not_recorded": 0
  },
  "hung_up_early": {
    "count": 0,
    "recorded": 0
  },
  "response_time": {
    "p50_seconds": 0,
    "p95_seconds": 0,
    "turns": 0,
    "calls": 0
  },
  "daily": [
    {
      "date": "string",
      "inbound": 0,
      "outbound": 0,
      "web": 0
    }
  ],
  "statuses": {
    "completed": 0,
    "no_answer": 0,
    "busy": 0,
    "failed": 0
  },
  "hourly": [
    {
      "hour": 0,
      "inbound": 0,
      "outbound": 0,
      "web": 0
    }
  ],
  "heatmap": [
    {
      "weekday": 0,
      "hour": 0,
      "count": 0
    }
  ],
  "unavailable": [
    "string"
  ]
}

How the numbers work

Same as the dashboard

These are the numbers shown on the Insights pages of the dashboard, for the same range and filters.

Who is counted

Counts follow the access of the member who created the API key. A key made by a member limited to some WhatsApp numbers only sees those numbers.

unavailable

Lists the parts that could not be loaded this time (for example "whatsapp" or "tickets"). Those parts come back empty; retry later for them.

Caching

Results are cached for 15 minutes, or 1 minute when the range includes today.

Errors

422 when the range or time zone is not valid. 503 with insights_timeout when the query takes too long; try a shorter range.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Body

application/json

startstring (ISO 8601)required

Start of the range, with a time zone offset, e.g. 2026-11-01T00:00:00+03:00.

endstring (ISO 8601)required

End of the range. Must be after start, at most 366 days later, and not after the end of today in tz.

tzstringrequired

IANA time zone used for daily and hourly buckets, e.g. Asia/Riyadh.

agent_idstring (UUID)

Only count conversations handled by this agent.

channelstring

"all" (default), "voice" or "whatsapp".

Example

{
  "start": "2026-11-01T00:00:00+03:00",
  "end": "2026-11-12T23:59:59+03:00",
  "tz": "Asia/Riyadh"
}

Response

200

Successful Response

application/json

422

Validation Error

application/json

API referenceGet call insights

Analytics

Get call insights

POST

https://api.nabrah.ai/api/ext/insights/voice

Get call insights

curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/insights/voice' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start": "2026-11-01T00:00:00+03:00",
  "end": "2026-11-12T23:59:59+03:00",
  "tz": "Asia/Riyadh"
}'

{
  "totals": {
    "total": 0,
    "inbound": 0,
    "outbound": 0,
    "web": 0
  },
  "connected": 0,
  "not_connected": {
    "no_answer": 0,
    "busy": 0,
    "failed": 0
  },
  "avg_duration_seconds": 0,
  "ended_by": {
    "customer": 0,
    "agent": 0,
    "no_response": 0,
    "time_limit": 0,
    "voicemail": 0,
    "transfer": 0,
    "not_recorded": 0
  },
  "hung_up_early": {
    "count": 0,
    "recorded": 0
  },
  "response_time": {
    "p50_seconds": 0,
    "p95_seconds": 0,
    "turns": 0,
    "calls": 0
  },
  "daily": [
    {
      "date": "string",
      "inbound": 0,
      "outbound": 0,
      "web": 0
    }
  ],
  "statuses": {
    "completed": 0,
    "no_answer": 0,
    "busy": 0,
    "failed": 0
  },
  "hourly": [
    {
      "hour": 0,
      "inbound": 0,
      "outbound": 0,
      "web": 0
    }
  ],
  "heatmap": [
    {
      "weekday": 0,
      "hour": 0,
      "count": 0
    }
  ],
  "unavailable": [
    "string"
  ]
}

How the numbers work

Same as the dashboard

These are the numbers shown on the Insights pages of the dashboard, for the same range and filters.

Who is counted

Counts follow the access of the member who created the API key. A key made by a member limited to some WhatsApp numbers only sees those numbers.

unavailable

Lists the parts that could not be loaded this time (for example "whatsapp" or "tickets"). Those parts come back empty; retry later for them.

Caching

Results are cached for 15 minutes, or 1 minute when the range includes today.

Errors

422 when the range or time zone is not valid. 503 with insights_timeout when the query takes too long; try a shorter range.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Body

application/json

startstring (ISO 8601)required

Start of the range, with a time zone offset, e.g. 2026-11-01T00:00:00+03:00.

endstring (ISO 8601)required

End of the range. Must be after start, at most 366 days later, and not after the end of today in tz.

tzstringrequired

IANA time zone used for daily and hourly buckets, e.g. Asia/Riyadh.

agent_idstring (UUID)

Only count conversations handled by this agent.

channelstring

"all" (default), "voice" or "whatsapp".

Example

{
  "start": "2026-11-01T00:00:00+03:00",
  "end": "2026-11-12T23:59:59+03:00",
  "tz": "Asia/Riyadh"
}

Response

200

Successful Response

application/json

422

Validation Error

application/json