Get occupancy trends

curl -G https://api.opencurbos.com/api/analytics/occupancy-trends \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d siteId=3fa85f64-5717-4562-b3fc-2c963f66afa6 \
     -d period=week \
     -d granularity=day

{
  "status": "success",
  "data": {
    "series": [
      {
        "timestamp": "2024-04-01T00:00:00Z",
        "occupancy_percentage": 75.5,
        "occupied_stalls": 38,
        "total_stalls": 50
      },
      {
        "timestamp": "2024-04-02T00:00:00Z",
        "occupancy_percentage": 82,
        "occupied_stalls": 41,
        "total_stalls": 50
      },
      {
        "timestamp": "2024-04-03T00:00:00Z",
        "occupancy_percentage": 68,
        "occupied_stalls": 34,
        "total_stalls": 50
      },
      {
        "timestamp": "2024-04-04T00:00:00Z",
        "occupancy_percentage": 90,
        "occupied_stalls": 45,
        "total_stalls": 50
      },
      {
        "timestamp": "2024-04-05T00:00:00Z",
        "occupancy_percentage": 85,
        "occupied_stalls": 43,
        "total_stalls": 50
      },
      {
        "timestamp": "2024-04-06T00:00:00Z",
        "occupancy_percentage": 78,
        "occupied_stalls": 39,
        "total_stalls": 50
      },
      {
        "timestamp": "2024-04-07T00:00:00Z",
        "occupancy_percentage": 80,
        "occupied_stalls": 40,
        "total_stalls": 50
      }
    ],
    "summary": {
      "avg_occupancy": 79.5,
      "peak_occupancy": 90,
      "peak_time": "2024-04-04T00:00:00Z"
    }
  }
}

Returns time-series occupancy data showing stall utilization over the selected period.

Authentication

AuthorizationBearer

Organization API key from your settings page

Query parameters

siteIdstringRequiredformat: "uuid"

UUID of the site to query analytics for

periodenumOptionalDefaults to today

Predefined time period (ignored when startDate/endDate provided)

Allowed values:

startDatedatetimeOptional

Custom range start (ISO 8601). Must be paired with endDate.

endDatedatetimeOptional

Custom range end (ISO 8601). Must be paired with startDate.

granularityenumOptionalDefaults to day

Time bucket size. Hour granularity only available for "today" period.

Allowed values:

Response

Successful response

statusenum

Allowed values:

dataobject

Zod schema for full occupancy trends data

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error