Skip to main content
GET
/
api
/
v1
/
ops
/
reports
/
transfers
/
insights
Get Transfers Insights
curl --request GET \
  --url https://api.example.com/api/v1/ops/reports/transfers/insights \
  --header 'Authorization: Bearer <token>'
{
  "transferred": 800000,
  "processing": 120000,
  "pending": 60000,
  "failed": 2
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
amount
string

Amount range

Example:

">=10;<=50"

​
createdAt
string

Created at range

Example:

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

​
transferredAt
string

Transferred at 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

Transfers insights

​
transferred
integer
required

Transferred total in cents

Example:

800000

​
processing
integer
required

Processing total in cents

Example:

120000

​
pending
integer
required

Pending total in cents

Example:

60000

​
failed
integer
required

Failed count

Example:

2