One-shot publishing analytics dashboard payload

curl --request GET \
  --url https://api.royalti.io/publisher/analytics/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/publisher/analytics/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/publisher/analytics/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/publisher/analytics/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/analytics/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "<string>",
  "data": {
    "sections": {
      "earnings": {
        "bySociety": {
          "dimension": "society",
          "rows": [
            {
              "key": "<string>",
              "label": "<string>"
            }
          ],
          "totals": {},
          "currency": "<string>",
          "meta": {}
        },
        "byRightType": {
          "dimension": "society",
          "rows": [
            {
              "key": "<string>",
              "label": "<string>"
            }
          ],
          "totals": {},
          "currency": "<string>",
          "meta": {}
        }
      },
      "coverage": {
        "dimension": "society",
        "rows": [
          {
            "key": "<string>",
            "label": "<string>"
          }
        ],
        "totals": {},
        "currency": "<string>",
        "meta": {}
      },
      "recoupment": {
        "dimension": "society",
        "rows": [
          {
            "key": "<string>",
            "label": "<string>"
          }
        ],
        "totals": {},
        "currency": "<string>",
        "meta": {}
      }
    },
    "currency": "<string>",
    "period": {
      "start": "<string>",
      "end": "<string>"
    },
    "generatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

GET

publisher

analytics

summary

One-shot publishing analytics dashboard payload

curl --request GET \
  --url https://api.royalti.io/publisher/analytics/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/publisher/analytics/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/publisher/analytics/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/publisher/analytics/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/analytics/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "<string>",
  "data": {
    "sections": {
      "earnings": {
        "bySociety": {
          "dimension": "society",
          "rows": [
            {
              "key": "<string>",
              "label": "<string>"
            }
          ],
          "totals": {},
          "currency": "<string>",
          "meta": {}
        },
        "byRightType": {
          "dimension": "society",
          "rows": [
            {
              "key": "<string>",
              "label": "<string>"
            }
          ],
          "totals": {},
          "currency": "<string>",
          "meta": {}
        }
      },
      "coverage": {
        "dimension": "society",
        "rows": [
          {
            "key": "<string>",
            "label": "<string>"
          }
        ],
        "totals": {},
        "currency": "<string>",
        "meta": {}
      },
      "recoupment": {
        "dimension": "society",
        "rows": [
          {
            "key": "<string>",
            "label": "<string>"
          }
        ],
        "totals": {},
        "currency": "<string>",
        "meta": {}
      }
    },
    "currency": "<string>",
    "period": {
      "start": "<string>",
      "end": "<string>"
    },
    "generatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

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, earnings-by-period (month granularity), 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. Every money figure is FX-normalised into the tenant’s base currency; currency is that base currency and each section declares meta.fxNormalized. Authorization: user role + publisher capability enabled.

Code Examples

const response = await fetch('https://api.royalti.io/publisher/analytics/summary', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
  'https://api.royalti.io/publisher/analytics/summary',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/publisher/analytics/summary \
  -H "Authorization: Bearer YOUR_TOKEN" \

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.

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

Show child attributes

​Description

​Code Examples

Authorizations

Query Parameters

Response

Description

Code Examples