Skip to main content
GET
Get Occupancy By Route

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

departureAt
string

Departure range

Example:

">=2024-01-01;<=2024-12-31"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

routeId
string<uuid>
required

Route identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

origin
string
required

Origin name

Example:

"São Paulo"

destination
string
required

Destination name

Example:

"Rio de Janeiro"

seatsSold
integer
required

Seats sold

Example:

244

capacity
integer
required

Total seats

Example:

300

occupancyRate
number
required

Occupancy percent

Required range: x >= 0
Example:

81.3

trips
integer
required

Trips count

Example:

6