Aggregates

Aggregates refer to historical, pre-computed statistics and counts of events that occur at specific curbside locations, summarized on an hourly basis. These aggregates provide a consolidated view of event activity over time, helping to identify trends and patterns in curb usage. The data used to generate these aggregates is derived from sessions recorded in the system, which captures detailed information about individual events. By analyzing these hourly aggregates, cities and organizations can gain insights into curbside activities, such as peak usage times, frequency of events, and overall trends, which can inform planning and operational strategies.

Query Aggregates

get

Access metrics data in the Curb Data Specification format. Requires the start_time and end_time parameters. The curb_place_type and curb_place_id parameters are optional.

Query parameters
curbiq_tokenstringRequired

Required for client authentication to query the database.

curb_place_typestringOptional

CDS
The type of curb place this aggregate applies to from the Curbs API: area, zone, space.

curb_place_idstring · uuidOptional

CDS
The ID of this curb place.

metric_typestringOptional

CDS
The metric this aggregate applies to: total_sessions, average_dwell_time, occupancy_percent

latnumber · floatOptional

CDS
Latitude at the center of the search circle.
This parameter is conditionally required if either 'lng' or 'radius' is specified.

lngnumber · floatOptional

CDS
Longitude at the center of the search circle.
This parameter is conditionally required if either 'lat' or 'radius' is specified.

radiusnumber · floatOptional

CDS
Radius of the search circle.
This parameter is conditionally required if either 'lat' or 'lng' is specified.

min_latnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

min_lngnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

max_latnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

max_lngnumber · floatOptional

CDS
For querying policies associated with all zones within a bounding box.
If any of 'min_lat', 'min_lng', 'max_lat', or 'max_lng' are specified, all must be.
If specified only return Curb Zones that intersect the supplied bounding box.

start_timeinteger · int64Optional

CDS
The Aggregates object will return all aggregates after this start_time.
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

CDS
The Aggregates object will return all aggregates before this end_time.
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

Successful response. Aggregates as comma-separated values.

No content
get
GET /metrics/aggregates HTTP/1.1
Host: v2.curbiq-curb-api.io
Accept: */*

No content

Note: Custom response limits have been placed to manage query operations/system loads and response time.

  • If a curb_place_id is not specified: end_time - start_time should not exceed two weeks

  • If a curb_place_id is specified: end_time - start_time should not exceed three months

PreviousMetrics

Last updated