Booking · Resources · Statistics
Get resource utilization
Returns resource utilization for fromDate through toDate and the preceding period of the same length. The summary includes utilization, booked and blocked hours, booked value in cents, and the number of resources with reservations. It also returns booked hours by month and up to five resources with the highest utilization; canceled reservations are excluded from hours.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Callers need
mandate.read,resource.read,resourceReservation.read, andbooking.read.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
fromDatestringrequired -
toDatestringrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/resources/statistics/utilization' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/resources/statistics/utilization", {
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/booking/resources/statistics/utilization', 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
-
summaryobject10 properties
-
utilizationPercentnumberat least 0
-
previousUtilizationPercentnumberat least 0
-
bookedHoursnumberat least 0
-
previousBookedHoursnumberat least 0
-
blockedHoursnumberat least 0
-
previousBlockedHoursnumberat least 0
-
bookedValuenumberat least 0
-
previousBookedValuenumberat least 0
-
activeResourceCountintegerat least 0
-
previousActiveResourceCountintegerat least 0
-
-
monthsobject[]2 properties
-
datestring -
bookedHoursnumberat least 0
-
-
topResourcesobject[]If no resources have booked hours,
topResourcesis empty.4 properties
-
resourceid -
namestring -
bookedHoursnumberat least 0
-
utilizationPercentnumberat least 0
-
{
"summary": {
"utilizationPercent": 0,
"previousUtilizationPercent": 0,
"bookedHours": 0,
"previousBookedHours": 0,
"blockedHours": 0,
"previousBlockedHours": 0,
"bookedValue": 0,
"previousBookedValue": 0,
"activeResourceCount": 0,
"previousActiveResourceCount": 0
},
"months": [
{
"date": "string",
"bookedHours": 0
}
],
"topResources": [
{
"resource": "000000000000000000000001",
"name": "string",
"bookedHours": 0,
"utilizationPercent": 0
}
]
}
Errors
1 rare error, such as when something changes at the same moment
| Status | Error | When |
|---|---|---|
| 408 | Cache loading timed out | If loading information needed for the statistics takes too long. |
Errors nearly every request can meet are listed under Errors.