Skip to main content
GET
/
api
/
v1
/
bko
/
reports
/
overview
Get Overview
curl --request GET \
  --url https://api.example.com/api/v1/bko/reports/overview \
  --header 'Authorization: Bearer <token>'
{
  "transactedVolume": 9800000,
  "revenue": 490000,
  "pendingTransfers": 1200000,
  "activeOrganizations": 42
}

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

Platform overview

​
transactedVolume
integer
required

Transacted volume today in cents

Example:

9800000

​
revenue
integer
required

Platform net revenue today in cents

Example:

490000

​
pendingTransfers
integer
required

Pending transfers total in cents

Example:

1200000

​
activeOrganizations
integer
required

Active organizations count

Example:

42