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

Events

PreviousEventsNextStatus

Last updated 3 months ago

A Curb Event is a detailed record of activities that occur within the specific geographic boundaries defined by a Curb Zone or Curb Area. This event captures various types of actions or incidents related to curbside usage, such as parking, loading, unloading, or enforcement activities. Each Curb Event is associated with a particular location and time, providing valuable insights into how curb spaces are utilized. The data from these events can be used for real-time monitoring, historical analysis, and operational decision-making, helping cities manage and optimize curbside resources effectively.

Query Event

get

Access Events data in the Curb Data Specification format. Requires either a curb place parameter (curb_area_id, curb_zone_id, curb_space_id) or start_time and end_time.

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 events occurring within this area.

curb_zone_idstring · UUIDOptional

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

curb_space_idstring · UUIDOptional

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

start_timeinteger · int64Optional

CCDS

  • Conditionally required: if curb_area_id, curb_zone_id, and curb_space_id not provided The Events object will return all events after this start_time.
    Please note: end_time is required if start_time is entered and must be within 24 hours.
    This parameter takes a time in the Timestamp format in milliseconds Otherwise, the server should reply with 404 Not Found. Availability data (if supplied) will be returned as of this time.
Example: 1643130000000
end_timeinteger · int64Optional

CCDS

  • Conditionally required: if curb_area_id, curb_zone_id, and curb_space_id not provided The Events object will return all events before this end_time.
    Please note: start_time is required if end_time is entered and must be within 24 hours.
    This parameter takes a time in the Timestamp format in milliseconds Otherwise, the server should reply with 404 Not Found. Availability data (if supplied) will be returned as of this time.
Example: 1643130000000
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/events 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": {
      "curb_zone_id": "63d8fb53-c903-4553-aff5-7184096baf17",
      "curbiq_token": "curbiq_token",
      "start_time": 1643130000000,
      "end_time": 1704171600000,
      "page_num": 1,
      "response_size": 10
    }
  },
  "pages": {
    "total": 100,
    "current": 1
  },
  "data": {
    "events": [
      {
        "event_id": "2f247f37-8775-4ca1-a7a8-3bbb635371ee",
        "event_type": "park_end",
        "event_location": {
          "type": "feature",
          "properties": {
            "timestamp": 1741302839000
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.341249511,
              47.617270682
            ]
          }
        },
        "event_time": 1741302094530,
        "event_publication_time": 1741303094530,
        "event_session_id": "8976dbd2-9854-47d2-a55a-376c90bc8a3d",
        "curb_zone_id": "582d023b-0110-4080-ab35-b8b391f55e36",
        "curb_area_ids": "63d8fb53-c903-4553-aff5-7184096baf1",
        "data_source_type": "above_ground",
        "data_source_operator_id": "a774fecb-2a69-4161-8847-fa0e59e8cc0f",
        "data_source_operator_name": "operator_name",
        "data_source_device_id": "1a8538fc-d40b-48fe-9b35-402996d65a95",
        "data_source_device_name": "parking_meter_23",
        "data_source_manufacturer": null,
        "data_source_model": null,
        "sensor_status_is_online": true
      }
    ]
  },
  "links": {
    "first": "https://dev.curbiq-curb-api.io/events/events?curb_zone_id=63d8fb53-c903-4553-aff5-7184096baf17&curbiq_token=curbiq_token&end_time=1741392795000&page_num=1&response_size=10&start_time=1741299064000",
    "last": "https://dev.curbiq-curb-api.io/events/events?curb_zone_id=63d8fb53-c903-4553-aff5-7184096baf17&curbiq_token=curbiq_token&end_time=1741392795000&page_num=10&response_size=10&start_time=1741299064000",
    "prev": "https://dev.curbiq-curb-api.io/events/events?curb_zone_id=63d8fb53-c903-4553-aff5-7184096baf17&curbiq_token=curbiq_token&end_time=1741392795000&page_num=1&response_size=10&start_time=1741299064000",
    "next": "https://dev.curbiq-curb-api.io/events/events?curb_zone_id=63d8fb53-c903-4553-aff5-7184096baf17&curbiq_token=curbiq_token&end_time=1741392795000&page_num=3&response_size=10&start_time=1741299064000"
  }
}