Skip to main content
GET
/
revenue
/
Get Revenues
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/revenue/ \
  --header 'Authorization: Bearer <token>'
{
  "message": "Revenues retrieved successfully",
  "revenues": [
    {
      "id": "revenue-uuid-123",
      "title": "Streaming Revenue - January 2024",
      "amount": 2500.5,
      "currency": "USD",
      "source": "streaming",
      "transactionDate": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 150,
  "page": 1,
  "size": 10,
  "totalPages": 15,
  "summary": {
    "totalAmount": 125000.75,
    "totalCount": 150,
    "byCurrency": {
      "USD": 100000.5,
      "EUR": 25000.25
    },
    "bySource": {
      "streaming": 80000.3,
      "sales": 30000.25,
      "licensing": 15000.2
    }
  }
}
Get Revenues Description:
The /revenue/ endpoint retrieves a list of revenue records with filtering, pagination, and inclusion options.
Method:
GET
Query Parameters:
ParameterTypeDescription
q (Optional)stringSearch query to filter revenues
page (Optional)integerPage number for pagination. Default: 1
size (Optional)integerNumber of revenues per page. Default: 10
sort (Optional)stringField to sort by. Default: ‘transactionDate’
order (Optional)stringSort order (‘asc’ or ‘desc’). Default: ‘desc’
source (Optional)stringFilter by revenue source
artist (Optional)stringFilter by artist ID
asset (Optional)stringFilter by asset ID
product (Optional)stringFilter by product ID
currency (Optional)stringFilter by currency
dateFrom (Optional)stringFilter revenues from this date
dateTo (Optional)stringFilter revenues to this date
include (Optional)stringAdditional data to include (Artist, Asset, Product)

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Query Parameters

ParameterTypeInRequiredDescription
qstringquerySearch query to filter revenues
pageintegerqueryPage number for pagination
sizeintegerqueryNumber of revenues per page
sortstringqueryField to sort by
orderstringquerySort order (‘asc’ or ‘desc’)
sourcestringqueryFilter by revenue source
artiststringqueryFilter by artist ID
assetstringqueryFilter by asset ID
productstringqueryFilter by product ID
currencystringqueryFilter by currency
dateFromstringqueryFilter revenues from this date
dateTostringqueryFilter revenues to this date
includestringqueryAdditional data to include (Artist, Asset, Product)

Responses

✅ 200 - Success

⚠️ 401 - Unauthorized

❌ 500 - Internal Server Error

Tags

Revenue

Authorizations

Authorization
string
header
required

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

Query Parameters

q
string

Search query to filter revenues

page
integer
default:1

Page number for pagination

size
integer
default:10

Number of revenues per page

sort
string
default:transactionDate

Field to sort by

order
enum<string>
default:desc

Sort order ('asc' or 'desc')

Available options:
asc,
desc
source
enum<string>

Filter by revenue source

Available options:
streaming,
sales,
licensing,
sync,
merchandise,
live_performance,
other
artist
string

Filter by artist ID

asset
string

Filter by asset ID

product
string

Filter by product ID

currency
string

Filter by currency

dateFrom
string<date>

Filter revenues from this date

dateTo
string<date>

Filter revenues to this date

include
string

Additional data to include (Artist, Asset, Product)

Response

Success

message
string
revenues
object[]
total
integer
page
integer
size
integer
totalPages
integer
summary
object
I