Crm · Contacts · Statistics
Get contact type overview
Returns how many contacts of a type are active today and were active on the same date last month, with their entries, exits and active count per month of the given period. Members, employees and contributors use their own start and end dates. The other types have no end date, so their entries are the contacts created in a month, and tracksExits is false
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readcontact:<contactType>.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
contactTypestringrequiredmemberaddresscustomersponsorcontributoremployeesupplier -
fromDatestringrequired -
toDatestringrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contacts/statistics/typeOverview' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contacts/statistics/typeOverview", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contacts/statistics/typeOverview', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
activeintegerat least 0
-
previousMonthActiveintegerat least 0
-
tracksExitsboolean -
monthsobject[]4 properties
-
datestring -
entriesintegerat least 0
-
exitsintegerat least 0
-
activeMembersintegerat least 0
-
Response200
{
"active": 0,
"previousMonthActive": 0,
"tracksExits": true,
"months": [
{
"date": "string",
"entries": 0,
"exits": 0,
"activeMembers": 0
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.