Get top gainers and losers vs the previous period
Get top gainers and losers vs the previous period
Description
Get top gainers and losers vs the previous period Ranks dimension values (assets, products, artists, DSPs, countries, sale types, or aggregators) by the change in royalty between the requested period and the equal-length prior period, returning the top gainers and top losers separately. Requires a bounded period: passstart (and optionally end). If start is
omitted, the endpoint returns an empty gainers/losers pair with an
explanatory message instead of an error.
Authorization:
- Required role:
useror higher
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Dimension to rank movers by. Defaults to (and falls back to) asset for an omitted/invalid value.
dsp, country, artist, asset, product, saletype, aggregator Number of gainers and number of losers to return. Clamped to 1-50.
1 <= x <= 50Filters 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 current period (YYYY-MM-DD format). Required — this endpoint needs a bounded period to compute deltas against the equal-length prior period
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
Filters by either 'accounting' or 'sale' period
accounting, sale Response
Successfully retrieved top movers (or an empty pair with message if no bounded period was given)