Skip to main content
GET
One-shot publishing analytics dashboard payload
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /publisher/analytics/summary Combines earnings-by-society, earnings-by-right-type, statement coverage, and recoupment status into one response so a dashboard can render without N round-trips. Each nested section is the same AnalyticsEnvelope shape as the standalone endpoints. Authorization: user role + publisher addon.

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

Response

Summary 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