Skip to main content
GET
Retrieve Partner Revenue Lines

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.

Scopes

company:basic:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-17-3"

Query Parameters

referring_account_id
string
required

Partner business to report on, prefixed biz_.

breakdown_by
enum<string>

revenue_line for one row per revenue line. Omit it for one row per window with the total commission.

Available options:
revenue_line
columns
string

Comma-separated columns to return on each row. Defaults to commission,paid. income_source is available on revenue_line rows.

windows
string

Comma-separated windows of at most 366 days, at most four, in the syntax every report accepts. Each window covers whole days, through the end of its last day. A prev: window covers as many days and ends where the window it precedes starts. Defaults to 30d.

time_zone
string

IANA zone that the days of each window fall in. Defaults to Etc/UTC.

revenue_line
string

Comma-separated revenue lines to keep.

income_source
string

Comma-separated income sources to keep.

order
enum<string>

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

Available options:
commission,
paid
direction
enum<string>

Ranking direction. Defaults to desc.

Available options:
asc,
desc
convert_to
string

Currency code to return money in. Defaults to usd.

first
integer
default:20

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

Required range: x <= 1000
after
string

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

Response

Each revenue line's figures for each requested window, with rows in the same order in every window.

data
object
required
page_info
object
required