Analytics API

Conversation outcomes and AI-credit usage.

Analytics overview

GET/v1/analytics/overview

The dashboard's Analytics → Overview numbers for a window (default the last 30 days, at most 366; clamped to your plan's analytics history — range_clamped_to_plan_history): conversations, messages, AI resolution rate, transfers to a human and CSAT, each with the previous period of equal length, plus the AI-credit balance.

Required scope: analytics:read.

Parameters

fromstring

tostring

Request

cURL

curl "https://api.asks.app/v1/analytics/overview" \
  -H "Authorization: Bearer $ASKS_API_KEY"

Response 200

JSON

{
  "object": "analytics_overview",
  "from": {},
  "to": {},
  "range_clamped_to_plan_history": true,
  "conversations": {
    "count": 1,
    "previous_count": 1,
    "change_pct": {}
  },
  "messages": {
    "count": 1,
    "previous_count": 1,
    "change_pct": {},
    "avg_per_conversation": {}
  },
  "ai_resolution": {
    "rate_pct": {},
    "previous_rate_pct": {},
    "resolved_by_ai": 1,
    "ai_involved": 1
  },
  "transferred_to_human": {
    "rate_pct": {},
    "previous_rate_pct": {},
    "count": 1
  },
  "csat": {
    "average": {},
    "previous_average": {},
    "responses": 1
  },
  "credits": {
    "used": 1,
    "limit": 1,
    "top_up_balance": 1,
    "cycle": "monthly",
    "resets_at": {}
  },
  "plan": "string"
}

← Previous

Channels

Webhook endpoints