CRM

Per-user, per-day activity counts with previous-period totals

GET
/v1/crm/reports/activity

Human actions only, attributed to the actor (never the record owner). previousTotals covers the equal-length period immediately before from. Ratios (connect rate, show rate, win rate) are client-side divisions.

Authorization

x-api-key<token>

In: header

Query Parameters

from?integer

Inclusive start of the range (epoch ms).

Range0 <= value
to?integer

Exclusive end of the range (epoch ms).

Range0 <= value
userId?string

Omit = the caller's own metrics. team = one entry per workspace member (owner/admin only). A member id = that member (owner/admin only).

tz?string

IANA zone the day buckets are cut in (default America/New_York).

listId?string

Scope every metric to that list's members and vocabulary. A 1-element alias for listIds — do not pass both.

listIds?string

CSV of list ids to scope to (union, not intersection — a record that's a member of more than one selected list is still counted once in every distinct-record metric and once per day-bucket). A list id the caller can't see is silently dropped, not an error. Do not pass alongside listId.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/crm/reports/activity"
{
  "data": {
    "from": 0,
    "to": 0,
    "users": [
      {
        "days": [
          {
            "calls": 0,
            "callsConnected": 0,
            "date": "string",
            "emails": 0,
            "meetingsCancelled": 0,
            "meetingsCompleted": 0,
            "meetingsNoShow": 0,
            "meetingsScheduled": 0,
            "notes": 0,
            "recordsAdded": 0,
            "recordsLost": 0,
            "recordsWon": 0,
            "talkTimeSeconds": 0,
            "tasksCompleted": 0,
            "tasksCreated": 0,
            "voicemails": 0
          }
        ],
        "previousTotals": {
          "calls": 0,
          "callsConnected": 0,
          "emails": 0,
          "meetingsCancelled": 0,
          "meetingsCompleted": 0,
          "meetingsNoShow": 0,
          "meetingsScheduled": 0,
          "notes": 0,
          "recordsAdded": 0,
          "recordsContacted": 0,
          "recordsLost": 0,
          "recordsWon": 0,
          "talkTimeSeconds": 0,
          "tasksCompleted": 0,
          "tasksCreated": 0,
          "voicemails": 0
        },
        "recordsContacted": 0,
        "totals": {
          "calls": 0,
          "callsConnected": 0,
          "emails": 0,
          "meetingsCancelled": 0,
          "meetingsCompleted": 0,
          "meetingsNoShow": 0,
          "meetingsScheduled": 0,
          "notes": 0,
          "recordsAdded": 0,
          "recordsLost": 0,
          "recordsWon": 0,
          "talkTimeSeconds": 0,
          "tasksCompleted": 0,
          "tasksCreated": 0,
          "voicemails": 0
        },
        "userId": "string"
      }
    ]
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}