Skip to main content
GET
/
api
/
v1
/
ops
/
reports
/
overview
Get Overview
curl --request GET \
  --url https://api.example.com/api/v1/ops/reports/overview \
  --header 'Authorization: Bearer <token>'
{
  "tripsScheduledToday": 12,
  "availableSeats": 320,
  "pendingReservations": 8,
  "ticketsSoldToday": 96,
  "ticketsSoldYesterday": 80,
  "revenueToday": 450000,
  "revenueYesterday": 400000
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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

Organization overview

​
tripsScheduledToday
integer
required

Trips scheduled today

Example:

12

​
availableSeats
integer
required

Available seats today

Example:

320

​
pendingReservations
integer
required

Pending reservations

Example:

8

​
ticketsSoldToday
integer
required

Tickets sold today

Example:

96

​
ticketsSoldYesterday
integer
required

Tickets sold yesterday

Example:

80

​
revenueToday
integer
required

Net revenue today in cents

Example:

450000

​
revenueYesterday
integer
required

Net revenue yesterday in cents

Example:

400000