Get aggregated contact metrics
curl --request GET \
--url https://your-instance.example.com/api/contact-metrics/contact \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/contact-metrics/contact"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/contact-metrics/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/contact-metrics/contact",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/contact-metrics/contact"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/contact-metrics/contact")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact-metrics/contact")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"error": "Invalid pipeline ID"
}{
"error": "Invalid pipeline ID"
}Contact Metrics
Get aggregated contact metrics
Return aggregated contact counts bucketed by the categories configured for the org/pipeline (e.g. “New”, “Working”, “Closed”), with contacted/never-contacted splits. Scope is derived from the caller’s role (own contacts / department / whole org).
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>'import requests
url = "https://your-instance.example.com/api/contact-metrics/contact"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/contact-metrics/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/contact-metrics/contact",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/contact-metrics/contact"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/contact-metrics/contact")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contact-metrics/contact")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"error": "Invalid pipeline ID"
}{
"error": "Invalid pipeline ID"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
⌘I