Skip to main content
GET
/
split
/
summary
Get Split Summary
curl --request GET \
  --url https://api.royalti.io/split/summary \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/split/summary"

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

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

url = URI("https://api.royalti.io/split/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
{
  "message": "success",
  "summary": {
    "total": 200,
    "byType": {
      "Default": 100,
      "Publishing": 50,
      "YouTube": 30,
      "Live": 20
    },
    "byLevel": {
      "productLevel": 123,
      "assetLevel": 123,
      "productAssetLevel": 123
    },
    "withConditions": 123,
    "withoutConditions": 123
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get Split Summary The Get Split Summary endpoint returns aggregated split statistics for the tenant. Method: GET Response Data:
FieldTypeDescription
totalintegerTotal number of splits
byTypeobjectCount of splits grouped by type (Default, Publishing, YouTube, Live)
byLevelobjectCount of splits by level (productLevel, assetLevel, productAssetLevel)
withConditionsintegerNumber of splits with conditions
withoutConditionsintegerNumber of splits without conditions
Query Parameters:
ParameterTypeDescription
startDate (Optional)stringFilter splits created from this date (inclusive)
endDate (Optional)stringFilter splits created to this date (inclusive)
type (Optional)stringFilter by split type

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
startDate
string<date>

Filter splits created from this date (inclusive)

​
endDate
string<date>

Filter splits created to this date (inclusive)

​
type
enum<string>

Filter by split type

Available options:
Default,
Publishing,
YouTube,
Live

Response

Success

​
message
string
Example:

"success"

​
summary
object