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
    }
  }
}

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

200
application/json

Success

The response is of type object.