Get Royalties Summary
Get a summary of Royalties
Description
Get a summary of Royalties This endpoint provides a comprehensive summary of royalty data including downloads, streams, total royalties, and comparative analytics. Authorization:- Required role:
useror higher
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Filters the data by artist. Comma-separated list of artist IDs
Filters the data by user. Specifies a user ID
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)
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
Includes analytical data for percentage change
Filters by either 'accounting' or 'sale' period
accounting, sale Response
Successfully retrieved royalty summary (may contain zero values if no data available)
Total number of downloads
Total royalty from downloads
Total number of streams
Total royalty from streams
Total royalty amount
Total count of plays/sales
Percentage change in royalty
Percentage change in count
Rate per 1000 streams/downloads
Previous period royalty amount
Previous period count
Stage-2 addition. Gross vs allocated (payable) vs unallocated
(gap + unresolved) revenue from the latest committed attribution
run for this tenant. Absent/null when the tenant has never
committed an attribution run (the engine is opt-in — this is the
normal state for most tenants, not a fault) or when the read
failed (see unallocatedError).
Set instead of unallocated when the Stage-2 read itself failed —
distinguishes "the engine never ran for this tenant" (both fields
absent) from "the read broke" (this field carries the error
message, unallocated is null). The rest of the summary is
still returned; this endpoint does not fail the whole request on
an unallocated-read error.