Insight KPIs
Headline KPIs for the scope. The summary stays open to every member
with insights access because it serves the base KPIs, so the call-quality
fields are nulled for a caller without conversation analytics rather than
the route being refused; clients read conversation_analytics to decide
whether to render them. conversation_access keeps its aggregate meaning:
counts cover the whole scope while drill-down lists are limited to the
caller's own conversations.
Authorization
OAuth2AuthorizationCodeBearer AuthorizationBearer <token>
In: header
Query Parameters
org_id*Org Id
Format
uuidsince?|null
until?|null
agent_id?|null
source?string|null
compare?Compare
Default
truepopulation?string|null
verify_locally?Verify Locally
Default
trueResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/insights/summary?org_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "since": "2019-08-24", "until": "2019-08-24", "current": { "conversations": 0, "text_analysed": 0, "text_pending": 0, "text_failed": 0, "failed": 0, "resolved": 0, "escalated": 0, "sentiment_conversations": 0, "resolution_rate": 0, "failure_rate": 0, "escalation_rate": 0, "recovery_rate": 0, "improved_share": 0, "declined_share": 0, "avg_duration_ms": 0, "wait_p50_ms": 0, "wait_p95_ms": 0, "slow_reply_rate": 0, "barge_in_rate": 0, "dead_air_share": 0 }, "previous": { "conversations": 0, "text_analysed": 0, "text_pending": 0, "text_failed": 0, "failed": 0, "resolved": 0, "escalated": 0, "sentiment_conversations": 0, "resolution_rate": 0, "failure_rate": 0, "escalation_rate": 0, "recovery_rate": 0, "improved_share": 0, "declined_share": 0, "avg_duration_ms": 0, "wait_p50_ms": 0, "wait_p95_ms": 0, "slow_reply_rate": 0, "barge_in_rate": 0, "dead_air_share": 0 }, "daily": [ { "day": "2019-08-24", "conversations": 0, "failed": 0, "resolved": 0, "escalated": 0, "text_analysed": 0, "wait_p50_ms": 0 } ], "hidden_frustration_rate": 0, "masked_frustration_conversations": 0, "paired_conversations": 0, "voice_message_coverage": 0, "voice_conversation_coverage": 0, "voice_partial_conversations": 0, "voice_population": "string", "voice_population_status": "string", "voice_experimental": true, "hidden_frustration_daily": [], "open_incidents": 0, "conversation_access": "all", "conversation_analytics": false}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}