Skip to main content
GET
/
publisher
/
analytics
/
recoupment-status
Recoupment status across sub-publishing agreements
curl --request GET \
  --url https://api.royalti.io/publisher/analytics/recoupment-status \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/publisher/analytics/recoupment-status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/publisher/analytics/recoupment-status', 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/recoupment-status",
  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/recoupment-status"

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

}
HttpResponse<String> response = Unirest.get("https://api.royalti.io/publisher/analytics/recoupment-status")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/analytics/recoupment-status")

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
{
  "message": "<string>",
  "data": {
    "dimension": "society",
    "rows": [
      {
        "key": "<string>",
        "label": "<string>"
      }
    ],
    "totals": {},
    "currency": "<string>",
    "meta": {}
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

eventType enum with amount/eventCount. totals.outstandingBalance is the FX-normalized (best-effort) sum of each agreement’s most-recent balance. Unlike the other analytics endpoints, the period range here filters the ledger’s eventDate directly (meta.periodBasis: "ledger-event-date"), not a statement-period overlap — with a range supplied, the outstanding balance is the running balance as of periodEnd (or latest, if no end given). Authorization: user role + publisher addon.

​
Code Examples

const response = await fetch('https://api.royalti.io/publisher/analytics/recoupment-status', {
  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/recoupment-status',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/publisher/analytics/recoupment-status \
  -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).

Response

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