Skip to main content
GET
/
api
/
contact-metrics
/
contact
Get aggregated contact metrics
curl --request GET \
  --url https://your-instance.example.com/api/contact-metrics/contact \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "scope": "Your Contacts",
    "total": 124,
    "contacted": 91,
    "neverContacted": 33,
    "categories": {
      "new": {
        "name": "New",
        "count": 22,
        "contacted": 0,
        "neverContacted": 22,
        "color": "#3B82F6"
      },
      "working": {
        "name": "Working",
        "count": 47,
        "contacted": 38,
        "neverContacted": 9,
        "color": "#10B981"
      },
      "closed": {
        "name": "Closed",
        "count": 43,
        "contacted": 43,
        "neverContacted": 0,
        "color": "#6B7280"
      }
    },
    "uncategorized": {
      "count": 12,
      "contacted": 10,
      "neverContacted": 2
    },
    "pipelineId": "66f0a0b0c0d0e0f0a0b0c0d0",
    "pipelineName": "Sales pipeline"
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

startDate
string<date-time>
endDate
string<date-time>
pipelineId
string

Response

Contact metrics returned

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