Skip to main content
GET
Earnings attributed to individual songwriters
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

CWRWorkWriter rows, and each writer earns amount x relativeShare / 100 (meta.basis: "work-writer-relative-share"). Where a work’s shares do not add up to 100 the remainder stays unattributed - it is NOT normalised up. lineCount is a provenance figure: one line on a three-writer work counts once for each writer, so the per-writer counts sum to more than the tenant’s line total. Writers seen only in the BigQuery reading are keyed bq:<IPI or name>, because those ids live in the PRO’s identifier space rather than the CWRWriter UUID space; ipiNameNumber is the column to reconcile on. 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
Required range: 1 <= x <= 500

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).