Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Analytics

Call Scorecards

Scorecards of recent calls from their transcripts and analysis: talk ratio, questions asked, next step set, a score out of 100 and coaching tips.

API key access

Needs the analytics:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/analytics/call-scorecards

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Query Parameters

days?integer

Default 30

Formatint64
Range1 <= value <= 365
limit?integer

Default 50

Formatint64
Range1 <= value <= 200

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/analytics/call-scorecards?days=1&limit=1" \  -H "X-Workspace-Id: string"
{
  "days": 0,
  "summary": {
    "calls": 0,
    "avg_talk_ratio": 0,
    "avg_questions": 0,
    "next_step_rate": 0,
    "avg_score": 0,
    "coaching": [
      {
        "key": "string",
        "calls": 0,
        "of": 0,
        "tip": "string"
      }
    ]
  },
  "items": [
    {
      "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "lead_name": "string",
      "ended_at": "2019-08-24T14:15:22Z",
      "duration_seconds": 0,
      "outcome": "string",
      "next_step": "string",
      "scorecard": {
        "talk_ratio": 0.1,
        "agent_words": 0,
        "lead_words": 0,
        "questions": 0,
        "next_step_set": true,
        "score": 0,
        "tips": [
          "string"
        ]
      }
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Analytics Timeseries

The requested metrics per bucket (day, week from Monday, or month; UTC), zero-filled, split by `group_by`. At most 50 groups (largest totals of the first metric first; `truncated`). Default metrics: emails_sent, replies, replies_interested, bounces_hard, meetings_booked, calls_completed, opt_outs.

Forecast

Open deals with an explainable win probability (stage probability adjusted by activity, replies, meetings, next step, close date, plan progress and signature) and the weighted forecast by close-date month, with totals per currency (never converted) and per owner (RO-367).