Get a sale-month x accounting-month royalty matrix
Get a sale-month x accounting-month royalty matrix
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:
useror higher; theroyaltyAccesssubscription feature is required - No additional admin-only gate. Per-member (
user= single UUID) requests are scoped to that member’s splits andCountis always0
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
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
month, quarter Filters the data by artist. Comma-separated list of artist IDs
Filters the data by user. Specifies a user ID. A single UUID switches the response into per-member (splits-attributed) mode
Filter the data by country. Comma-separated values
Filters by DSP (Digital Service Provider). Comma-separated values
Start date of the period (YYYY-MM-DD format). Also used to decide whether to auto-roll up to quarterly granularity
End date of the period (YYYY-MM-DD format)
Filters by sale type. Comma-separated values
Filters by aggregator. Comma-separated values
Filters by data source table name. Comma-separated values for multiple tables
Filters by UPC (Universal Product Code). Comma-separated values
Filters by ISRC (International Standard Recording Code). Comma-separated values
Selects which axis the row-set is scoped by. Both AccountingMonth and SaleMonth are always returned on every row regardless. Defaults to accounting
accounting, sale