Skip to main content
GET
Get a sale-month x accounting-month royalty matrix
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get a sale-month x accounting-month royalty matrix Returns royalty and count bucketed by both sale month and accounting month simultaneously, useful for visualizing reporting lag between when a sale happened and when it was accounted for. Capped at 1000 rows (truncated: true when the cap is hit). Authorization:
  • Required role: user or higher; the royaltyAccess subscription feature is required
  • No additional admin-only gate. Per-member (user = single UUID) requests are scoped to that member’s splits and Count is always 0

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

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 which axis the row-set is scoped by. Both AccountingMonth and SaleMonth are always returned on every row regardless. Defaults to accounting

Available options:
accounting,
sale

Response

Successfully retrieved the period matrix

granularity
enum<string>
Available options:
month,
quarter
autoRolledUp
boolean
periodFilterType
enum<string>
Available options:
sale,
accounting
truncated
boolean

True when the result set hit the 1000-row cap

results
object[]