v1

latestOpenAPI 3.1.02026-07-24334970.2 KB

Analytics

Get metrics for a specific priority

Retrieves aggregated time-series metrics (visitors, queue size, status) for a specific priority over a given time range.

get/priorities/{id}/metrics

Path parameters

idstring uuid required

Unique identifier of the priority.

Query parameters

fromstring required

Example:2025-10-27T08:00:00Z

Start date-time (inclusive). Accepted formats: YYYY-MM-DD HH:mm:ss, YYYY-MM-DDTHH:mm:ss+HH:MM (ISO 8601 with offset), YYYY-MM-DDTHH:mm:ssZ (ISO 8601 UTC).

tostring

Example:2025-10-27T10:00:00Z

End date-time (exclusive). Same accepted formats as from. Defaults to now if not provided.

Response

Successful response with analytics data.

Example response

{
  "meta": {
    "interval": "15m",
    "from": "2025-10-27T08:00:00Z",
    "to": "2025-10-27T10:00:00Z"
  },
  "data": [
    {
      "timestamp": "2025-10-27T08:15:00Z",
      "metrics": {
        "visitors": {
          "currentVisitors": 4500,
          "waitingVisitors": 120,
          "maxConcurrentVisitors": 4800,
          "admissionRatePerMinute": 100,
          "newVisitorsRatePerMinute": 50,
          "waitingRatePerMinute": 20,
          "admittedRatePerMinute": 45
        }
      },
      "state": {
        "status": "inProgress",
        "mode": "alwaysOn"
      }
    }
  ]
}