Skip to content
elasticStageDeveloper Portal

Royalty earnings for a creator in a period

GET
/api/v1/creators/{uuid}/stats/royalties
curl --request GET \
  --url 'https://example.com/api/v1/creators/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stats/royalties?period=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
uuid
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

Section titled “Query Parameters”
period
required
string
/^\d{4}-(0[1-9]|1[0-2])$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
period
required
string
currency
required
string
totals
required
object
units
required
integer
>= -9007199254740991 <= 9007199254740991
revenue
required
integer
>= -9007199254740991 <= 9007199254740991
royalties
required
integer
>= -9007199254740991 <= 9007199254740991
by_release
required
Array<object>
object
release_group
required
string
nullable
ean
required
string
nullable
units
required
integer
>= -9007199254740991 <= 9007199254740991
royalty_amount
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "period": "example",
  "currency": "example",
  "totals": {
    "units": 1,
    "revenue": 1,
    "royalties": 1
  },
  "by_release": [
    {
      "release_group": "example",
      "ean": "example",
      "units": 1,
      "royalty_amount": 1
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

503

Section titled “503”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}