CurbIQ API Documentation
  • 🗺️Getting Started
  • Authentication
  • Curbs
    • Zones
    • Areas
    • Spaces
    • Policies
  • Events
    • Events
    • Status
  • Metrics
    • Aggregates
Powered by GitBook
On this page
  1. Events

Status

PreviousEventsNextMetrics

Last updated 29 days ago

Event status is a real-time status update related to curbside infrastructure within a defined Curb Zone or Curb Area. Rather than describing curbside activities like parking or loading, this status specifically captures the operational status of devices installed at the curb — including sensors, cameras, meters, and other monitoring equipment. These events track whether devices are commissioned, online, or experiencing issues such as communication loss.

Query Event Status

get

Access Events Status data in the Curb Data Specification format. All query parameters are optional

Query parameters
curbiq_tokenstringRequired

Required for client authentication to query the database.

curb_area_idstring · UUIDOptional

CDS
The ID of a Curb Area. If specified, only return data_source_devices within this area.

curb_zone_idstring · UUIDOptional

CDS
The ID of a Curb Zone. If specified, only return data_source_devices within this zone.

curb_space_idstring · UUIDOptional

CDS
The ID of a Curb Space. If specified, only return data_source_devices within this space.

response_sizeintegerOptional

CCDS
Default is 100. The maximum response size is 250.

page_numintegerOptional

CCDS
Page number for paginated responses, default is 1.

Responses
200
A successful response containing Events.
application/json
400
Bad request. Error in the query parameters such as an invalid token.
get
GET /events/status HTTP/1.1
Host: v2.curbiq-curb-api.io
Accept: */*
{
  "version": "1.0.1",
  "time_zone": "US/Eastern",
  "last_updated": 1744045712000,
  "currency": "USD",
  "author": "CurbIQ",
  "license_url": null,
  "ccds_attributes": {
    "type": "curbiq_api_response",
    "request_type": "status",
    "city_id": "e0e37e56-f583-492f-89c2-083a42440d9d",
    "city_name": "seattle",
    "query_parameters": {
      "curbiq_token": "curbiq_token",
      "response_size": 5
    }
  },
  "pages": {
    "total": 100,
    "current": 1
  },
  "data": {
    "status": [
      {
        "data_source_device_id": "1a8538fc-d40b-48fe-9b35-402996d65a95",
        "data_source_type": "above_ground",
        "data_source_operator_id": "a774fecb-2a69-4161-8847-fa0e59e8cc0f",
        "data_source_operator_name": "operator_name",
        "data_source_device_name": "parking_meter_23",
        "sensor_status_is_commissioned": true,
        "sensor_status_is_online": true
      }
    ]
  },
  "links": {
    "first": "https://dev.curbiq-curb-api.io/events/status?curbiq_token=curbiq_token&response_size=5&page_num=1",
    "last": "https://dev.curbiq-curb-api.io/events/status?curbiq_token=curbiq_token&response_size=5&page_num=4",
    "prev": null,
    "next": "https://dev.curbiq-curb-api.io/events/status?curbiq_token=curbiq_token&response_size=5&page_num=2"
  }
}