Documentation

List Actual Usage

GET /actualusage

Retrieves actual usage data for a site.

Query Parameters

Parameter Type Required Description
site_id string Yes Site ID to retrieve actual usage data for
reservable_ids array of strings No Repeat reservable_ids (or reservable_ids[]) for multiple resource IDs.
tags array of strings No Repeat tags (or tags[]) for multiple tags.
limit integer No Page size. Defaults to 25,000.
offset integer No Zero-based page index. For example, limit=100&offset=1 returns records 101–200.
start date (YYYY-MM-DD) No Start date for record filter
end date (YYYY-MM-DD) No End date for record filter
user_id string No IDs of users to filter by
supervisor_id string No IDs of user supervisor to filter by
identifier string No Actual usage identifier of users to filter by
barcode string No Barcode of resources to filter by
category string No Category of resources to filter by
has_reservation boolean No Filter records by those that have a reservation associated
merge_threshold integer No When specified, merge actual usage records together for the same user and resource if the gap between the end and start time is less than or equal to the threshold in seconds
open_session boolean No Filter records by those that do or do not have an open session (no specified end time)
incl_invoices flag No Include invoices by passing true. Omit to leave them out.
metrics string No Join metric names with a plus sign encoded as %2B.

Response

Success Response (200 OK)

{
  "api_version": 1,
  "status": "success",
  "action": "unknown",
  "numitems": 0,
  "data": {
    "records": [],
    "metrics": []
  }
}

data.records contains actual usage records and data.metrics contains available metric names. numitems counts matching records before pagination.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Invalid query parameters
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: Caller lacks permission to view actual usage for the site
  • 404 Not Found: Site with the specified ID does not exist

See the Actual Usage API overview for related endpoints.