Skip to main content
GET
Retrieve Platform Trends

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-07"

Query Parameters

breakdown_by
enum<string>

What each row is. Omit it for one row per window, holding the window's total.

Available options:
business_type,
industry_type,
account_country,
customer_country
columns
string

Comma-separated properties and metrics to return on each row. Defaults to gross_revenue,businesses.

windows
string

Comma-separated windows, at most four: 1d, 7d, 30d, 90d, 365d, mtd, qtd, ytd, all_time, an explicit 2026-09-01..2026-10-01, any of these prefixed prev: for the equal-length period before, or suffixed @2026-09-01 to end earlier. Defaults to 30d.

time_zone
string

IANA zone that day, month, quarter and year boundaries fall in. Defaults to Etc/UTC.

order
enum<string>

The requested metric that ranks rows, by its value in the first window. Defaults to the first requested metric.

Available options:
gross_revenue,
businesses,
payments,
customers,
aov,
repeat_rate,
p99_gross_revenue,
new_businesses,
avg_business_age,
avg_owner_age,
avg_customer_age
direction
enum<string>

Ranking direction. Defaults to desc.

Available options:
asc,
desc
convert_to
string

Currency every money metric is converted into. Defaults to usd.

business_type
string

Only counts payments to businesses of these comma-separated business types, such as education.

industry_type
string

Only counts payments to businesses in these comma-separated industry types, such as options_trading.

account_country
string

Only counts payments to accounts located in these comma-separated countries, as ISO 3166-1 alpha-2 codes such as US.

customer_country
string

Only counts payments from customers in these comma-separated countries, as ISO 3166-1 alpha-2 codes such as US.

first
integer
default:20

Number of results to return from the start of the range.

Required range: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

Response

Platform trends for each requested window, with rows in the same order in every window.

data
object
required
page_info
object
required