Sales ยท Statistics
Get sales counters
Returns how many opportunities are open and their expected value in cents, the expected value of the opportunities created from the first of this month until today and in the same days of the previous month, and how many offers are open. The open offers are null without read access to receipts
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readopportunity.read
Also checked, depending on the request and the records it touches
receipt.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
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/sales/sales-counters' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/sales-counters", {
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/sales/sales-counters', 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
-
openOpportunitiesintegerat least 0
-
openValuenumberat least 0
-
newValueThisMonthnumberat least 0
-
previousMonthNewValuenumberat least 0
-
openOffersintegernullableat least 0
Response200
{
"openOpportunities": 0,
"openValue": 0,
"newValueThisMonth": 0,
"previousMonthNewValue": 0,
"openOffers": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.