AV / Ride-Hail AnalyticsAPI ReferenceAnalytics

Get peak hours

Returns the busiest hours ranked by total activity (pickups + dropoffs).

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.

Response

Successful response
statusenum
dataobject
Zod schema for full peak hours data

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error