Skip to main content
GET
/
api
/
contact-analytics
/
{contactId}
Get contact-level analytics (7 modules)
curl --request GET \
  --url https://your-instance.example.com/api/contact-analytics/{contactId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "engagement": {
      "score": 72,
      "trend": "warming",
      "label": "Active",
      "daysSinceLastInteraction": 2
    },
    "pipeline": {
      "currentStage": "qualified",
      "daysInCurrentStage": 4,
      "stageHistory": []
    },
    "calls": {
      "total": 8,
      "answered": 5,
      "unanswered": 3,
      "answerRate": 0.625
    },
    "conversations": {
      "total": 4,
      "resolved": 3,
      "resolutionRate": 0.75,
      "csatAverage": 4.6
    },
    "channels": {
      "preferred": "sms",
      "ranked": [
        "sms",
        "email"
      ],
      "breakdown": {
        "sms": 12,
        "email": 4
      }
    },
    "aiVsHuman": {
      "breakdown": {
        "AI": 9,
        "HUMAN": 7
      },
      "escalationCount": 1
    },
    "timeline": {
      "total": 47,
      "page": 1,
      "limit": 25,
      "totalPages": 2,
      "events": []
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contactId
string
required

Query Parameters

timelineLimit
string
timelinePage
string
force
enum<string>

Pass true to bypass the 5-minute in-memory cache (used by the refresh button).

Available options:
true

Response

Contact analytics returned

success
enum<boolean>
required
Available options:
true
data
object
required