GET
/
royalty
/
month
Get Royalties grouped by month (Sale period)
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/royalty/month \
  --header 'Authorization: Bearer <token>'
[
  {
    "period": "2023-01",
    "totalRoyalty": 1354.25,
    "totalCount": 128000,
    "breakdown": {
      "streams": 123000,
      "downloads": 5000
    }
  },
  {
    "period": "2023-02",
    "totalRoyalty": 1556.8,
    "totalCount": 138000,
    "breakdown": {
      "streams": 133000,
      "downloads": 5000
    }
  }
]

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

ā€‹
country
string

Filter the data by country. Comma-separated values

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

Response

200
application/json

Successfully retrieved royalty data by sale period

The response is of type object[].