Get royalties breakdown
get_royalties_breakdownRetrieve a paginated royalty breakdown grouped by dimensions such as track, DSP, release, territory, or period. Filter by label, release, ISRC, UPC, or date range.
Instructions
Get a cursor-paginated royalty breakdown grouped by one or more dimensions. group_by is REQUIRED and is a comma-separated, ordered subset of: track, dsp, release, territory, period (e.g. "release,dsp"). Filter by label_id, release_id, isrc, upc, and a start_date/end_date range.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| upc | No | Filter by UPC/barcode. | |
| isrc | No | Filter by ISRC. | |
| cursor | No | Pagination cursor. | |
| end_date | No | Range end, YYYY-MM-DD. | |
| group_by | Yes | Required. Comma-separated, ordered subset of: track, dsp, release, territory, period. | |
| label_id | No | Filter by label id. | |
| per_page | No | Items per page. | |
| release_id | No | Filter by release id. | |
| start_date | No | Range start, YYYY-MM-DD. |