Skip to main content
GET
Aggregate purchases

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Query Parameters

customer_id
string

Filters purchases by customer.

Pattern: ^cus_[A-Za-z0-9_-]+$
status
enum<string>

Filters by purchase payment status.

Available options:
any,
pending,
authorized,
paid,
abandoned,
refunded,
voided
platform
enum<string>

Filters by source platform.

Available options:
nuvemshop,
shopify,
woocommerce,
bling,
instagram,
popup
created_since
string<date-time>

Includes items created at or after this instant.

created_until
string<date-time>

Includes items created at or before this instant.

min_value_in_cents
integer

Minimum purchase amount in cents.

Required range: x >= 0
max_value_in_cents
integer

Maximum purchase amount in cents.

Required range: x >= 0
utm_source
string

Filters by the order's utm_source.

Maximum string length: 256
utm_medium
string

Filters by the order's utm_medium.

Maximum string length: 256
utm_campaign
string

Filters by the order's utm_campaign.

Maximum string length: 256
utm_content
string

Filters by the order's utm_content.

Maximum string length: 256
utm_term
string

Filters by the order's utm_term.

Maximum string length: 256
group_by
enum<string>

Groups the result by a dimension and returns its ranking.

Available options:
status,
platform,
currency,
day,
utm_source,
utm_medium,
utm_campaign,
utm_content,
utm_term
group_limit
integer
default:10

Maximum number of groups returned.

Required range: 1 <= x <= 50

Response

Aggregated purchase metrics.

object
string
required
Allowed value: "purchase_stats"
purchase_count
integer
required
Required range: x >= 0
customer_count
integer
required
Required range: x >= 0
revenue_in_cents
integer
required
average_ticket_in_cents
integer
required
currency
string | null
required
Example:

"BRL"

mixed_currencies
boolean
required
group_by
string | null
required
groups
object[]
required
groups_truncated
boolean
required