Aggregate purchases
Sums orders, revenue, average ticket, and unique customers using the same filters as the listing, with optional ranking by dimension, including UTM.
Authorizations
API key created in the organization settings.
Query Parameters
Filters purchases by customer.
^cus_[A-Za-z0-9_-]+$Filters by purchase payment status.
any, pending, authorized, paid, abandoned, refunded, voided Filters by source platform.
nuvemshop, shopify, woocommerce, bling, instagram, popup Includes items created at or after this instant.
Includes items created at or before this instant.
Minimum purchase amount in cents.
x >= 0Maximum purchase amount in cents.
x >= 0Filters by the order's utm_source.
256Filters by the order's utm_medium.
256Filters by the order's utm_campaign.
256Filters by the order's utm_content.
256Filters by the order's utm_term.
256Groups the result by a dimension and returns its ranking.
status, platform, currency, day, utm_source, utm_medium, utm_campaign, utm_content, utm_term Maximum number of groups returned.
1 <= x <= 50Response
Aggregated purchase metrics.
"purchase_stats"x >= 0x >= 0"BRL"