Crm · Contracts · Statistics
Get contract development
Returns the running subscriptions today and at the start of a period, the paused ones today, the ones ended in the period and in the period of the same length right before it, and the plans with the most running subscriptions, each with how many of them are paused or terminating, how many are still to start, the next collection date still to come, the interval and the fixed price
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readplan.readcontract.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
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/contracts/statistics/contractDevelopment' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contracts/statistics/contractDevelopment", {
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/contracts/statistics/contractDevelopment', 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
-
summaryobject5 properties
-
activeintegerat least 0
-
activeAtStartintegerat least 0
-
pausedintegerat least 0
-
endedintegerat least 0
-
previousEndedintegerat least 0
-
-
plansobject[]9 properties
-
planIdid -
namestring -
activeCountinteger -
pausedCountintegerat least 0
-
terminatingCountintegerat least 0
-
upcomingCountintegerat least 0
-
nextCollectAtstringnullable -
intervalstringnullablemonthquarterhalfYearyearcustomflexible -
priceintegernullable
-
Response200
{
"summary": {
"active": 0,
"activeAtStart": 0,
"paused": 0,
"ended": 0,
"previousEnded": 0
},
"plans": [
{
"planId": "000000000000000000000001",
"name": "string",
"activeCount": 1,
"pausedCount": 0,
"terminatingCount": 0,
"upcomingCount": 0,
"nextCollectAt": "string",
"interval": "month",
"price": 1
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.