Skip to main content
GET
Get a month/quarter x dimension crosstab
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get a month/quarter x dimension crosstab Buckets royalty and count by time period (month or quarter) crossed with a dimension (country, sale type, or DSP), keeping the top-N dimension values and folding the remainder into an “Other” bucket. Authorization:
  • Required role: user or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

dimension
enum<string>
default:country

Dimension to cross with time period

Available options:
country,
saletype,
dsp
topN
integer
default:8

Number of top dimension values to keep before bucketing the rest into "Other". Clamped to 1-12

Required range: 1 <= x <= 12
granularity
enum<string>
default:month

Time bucket size. The server auto-switches to quarter (and sets autoRolledUp: true in the response) when the requested window exceeds 24 months, regardless of what is requested here

Available options:
month,
quarter
artists
string

Filters the data by artist. Comma-separated list of artist IDs

user
string<uuid>

Filters the data by user. Specifies a user ID. A single UUID switches the response into per-member (splits-attributed) mode

country
string

Filter the data by country. Comma-separated values

dsp
string

Filters by DSP (Digital Service Provider). Comma-separated values

start
string<date>

Start date of the period (YYYY-MM-DD format). Also used to decide whether to auto-roll up to quarterly granularity

end
string<date>

End date of the period (YYYY-MM-DD format)

type
string

Filters by sale type. Comma-separated values

aggregator
string

Filters by aggregator. Comma-separated values

table_name
string

Filters by data source table name. Comma-separated values for multiple tables

upc
string

Filters by UPC (Universal Product Code). Comma-separated values

isrc
string

Filters by ISRC (International Standard Recording Code). Comma-separated values

periodFilterType
enum<string>
default:accounting

Selects the time-bucket axis. Defaults to accounting

Available options:
accounting,
sale

Response

Successfully retrieved crosstab data

dimension
enum<string>
Available options:
country,
saletype,
dsp
granularity
enum<string>
Available options:
month,
quarter
topN
integer

Number of top dimension values kept before bucketing the remainder into "Other"

autoRolledUp
boolean

True when the server auto-switched from month to quarter granularity because the requested window exceeds 24 months

results
object[]