Skip to content
campaiDeveloper
campai.com

Booking · Resources · Statistics

GET/{organizationId}/{mandateId}/booking/resources/statistics/utilizationReads only

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, and booking.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/booking/resources/statistics/utilization' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • summaryobject
    10 properties
    • utilizationPercentnumber

      at least 0

    • previousUtilizationPercentnumber

      at least 0

    • bookedHoursnumber

      at least 0

    • previousBookedHoursnumber

      at least 0

    • blockedHoursnumber

      at least 0

    • previousBlockedHoursnumber

      at least 0

    • bookedValuenumber

      at least 0

    • previousBookedValuenumber

      at least 0

    • activeResourceCountinteger

      at least 0

    • previousActiveResourceCountinteger

      at least 0

  • monthsobject[]
    2 properties
    • datestring
    • bookedHoursnumber

      at least 0

  • topResourcesobject[]

    If no resources have booked hours, topResources is empty.

    4 properties
    • resourceid
    • namestring
    • bookedHoursnumber

      at least 0

    • utilizationPercentnumber

      at least 0

Response200
{
  "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
StatusErrorWhen
408Cache loading timed outIf loading information needed for the statistics takes too long.

Errors nearly every request can meet are listed under Errors.