GET
/
royalty
/
country
Get Royalties grouped by country
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/royalty/country \
  --header 'Authorization: Bearer <token>'
[
  {
    "country": "United States",
    "countryCode": "US",
    "totalRoyalty": 3256.75,
    "totalCount": 325000,
    "percentage": "52.8%"
  },
  {
    "country": "United Kingdom",
    "countryCode": "GB",
    "totalRoyalty": 1456.5,
    "totalCount": 146000,
    "percentage": "23.6%"
  },
  {
    "country": "Canada",
    "countryCode": "CA",
    "totalRoyalty": 876.25,
    "totalCount": 87000,
    "percentage": "14.2%"
  }
]

Authorizations

ā€‹
Authorization
string
header
required

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

Query Parameters

ā€‹
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

ā€‹
dsp
string

Filters by DSP (Digital Service Provider). Comma-separated values

ā€‹
start
string<date>

Start date of the period (YYYY-MM-DD format)

ā€‹
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

ā€‹
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>

Filters by either 'accounting' or 'sale' period

Available options:
accounting,
sale

Response

200
application/json

Successfully retrieved royalty data by country

The response is of type object[].