Skip to main content
GET
/
api
/
v1
/
bko
/
reports
/
orders
/
insights
Get Orders Insights
curl --request GET \
  --url https://api.example.com/api/v1/bko/reports/orders/insights \
  --header 'Authorization: Bearer <token>'
{
  "paid": 48,
  "pending": 5,
  "canceled": 2,
  "averageValue": 9000
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
createdAt
string

Created at range

Example:

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

​
filter
string

Generic filter that matches against

  • code
Example:

"ORD-20260412"

​
organizationId
string<uuid>

Organization identifier

​
paymentMethod
enum<string>

Payment method

Available options:
CASH,
PIX,
CREDIT_CARD,
DEBIT_CARD
Example:

"PIX"

​
type
enum<string>

Order type

Available options:
POS,
ONLINE
Example:

"POS"

​
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

Orders insights

​
paid
integer
required

Paid count

Example:

48

​
pending
integer
required

Pending count

Example:

5

​
canceled
integer
required

Canceled count

Example:

2

​
averageValue
integer
required

Average paid value in cents

Example:

9000