Skip to main content
GET
Top-earning matched works
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

matchedWorkId) contribute — joins CWRWork for the title/ISWC label. Ordered by amount DESC, capped at limit (default 50, max 500) — this is a top-N view, not a full paginated list. Authorization: user role + publisher capability enabled.

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

periodStart
string<date>

Inclusive ISO date (YYYY-MM-DD). Filters by statement-period overlap unless the endpoint notes otherwise.

periodEnd
string<date>

Inclusive ISO date (YYYY-MM-DD).

source
string

Comma-joined list of source PROs. OR within the param, AND against the other filters. An unknown value is a 400.

rightType
string

Comma-joined list of PR/MR/SR, or UNSPECIFIED for the null bucket the endpoints publish. An unknown value is a 400.

territory
string

Comma-joined list of territories as reported on the line, or UNSPECIFIED for the null bucket. Open set - not validated.

publisherId
string

Comma-joined Publisher ids, applied through the parent statement. The BigQuery projection has no publisher entity, so that reading is skipped for the request and meta.filters.bigquery is "skipped".

matchStatus
string

Comma-joined list of unmatched/matched/disputed/ignored. disputed and ignored have no counterpart in the BigQuery projection, so that reading contributes nothing for them. An unknown value is a 400.

limit
integer
default:50

Top-earning works when page is absent.

Required range: 1 <= x <= 500
page
integer

1-based. Present switches the endpoint to paging and adds meta.totalItems / totalPages / currentPage; absent keeps the limit contract unchanged.

Required range: x >= 1
size
integer
default:10

Page size when page is given. Default 10, max 100.

Required range: 1 <= x <= 100

Response

Earnings fetched.

Standard server envelope used by the statement, reconciliation, sub-publishing, and analytics endpoints.

status
enum<string>
Available options:
success,
error
message
string
data
object

Uniform aggregation shape returned by every /analytics/* endpoint (locked contract, G-ANALYTICS).