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

url = "https://api.royalti.io/file/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/file/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/file/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/file/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/file/summary")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/file/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": "File summary retrieved successfully",
  "data": {
    "total": 142,
    "byStatus": {
      "pending": 3,
      "processing": 1,
      "processed": 85,
      "decompressing": 0,
      "decompressed": 12,
      "uploaded": 38,
      "failed": 3
    },
    "byType": {
      "file": 0,
      "royalty": 130,
      "invoice": 8,
      "receipt": 2,
      "report": 2
    },
    "byFormat": {
      "csv": 67,
      "xlsx": 43,
      "zip": 20,
      "tsv": 8,
      "txt": 4
    },
    "bySource": {
      "Spotify": 42,
      "Apple Music": 35,
      "Deezer": 18,
      "TIDAL": 12
    }
  }
}
{
"status": "error",
"message": "Unauthorized"
}
{
"status": "error",
"message": "Internal server error"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

All filters are optional and additive (AND logic). Authorization:
  • Required role: user or higher
  • Required feature: royaltyAccess

Code Examples

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

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

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

data = response.json()
print(data)
curl -X GET https://api.royalti.io/file/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 files created on or after this date

endDate
string<date>

Filter files created on or before this date

status
enum<string>

Filter by file status

Available options:
pending,
processing,
processed,
decompressing,
decompressed,
uploaded,
failed
type
enum<string>

Filter by file type

Available options:
file,
royalty,
invoice,
receipt,
report
format
string

Filter by file format (e.g. csv, xlsx, zip)

source
string

Filter by royalty source name (e.g. Spotify, Apple Music)

Response

Summary retrieved successfully

status
enum<string>
Available options:
success
message
string
data
object