Get royalty processing job status

curl --request GET \
  --url https://api.royalti.io/file/processing/{jobId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.royalti.io/file/processing/{jobId}', 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/processing/{jobId}",
  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/processing/{jobId}"

	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/file/processing/{jobId}")

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

{
  "id": "job_abc123xyz",
  "name": "royalty-text-processing",
  "status": "active",
  "progress": 45,
  "processedOn": "2024-01-15T10:30:00Z",
  "finishedOn": null,
  "failedReason": null,
  "data": {
    "fileName": "spotify_2024-01.csv",
    "royaltySource": "spotify",
    "accountingPeriod": "2024-01-01",
    "rowsProcessed": 45000,
    "rowsTotal": 100000
  }
}

GET

file

processing

{jobId}

Get royalty processing job status

curl --request GET \
  --url https://api.royalti.io/file/processing/{jobId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.royalti.io/file/processing/{jobId}', 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/processing/{jobId}",
  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/processing/{jobId}"

	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/file/processing/{jobId}")

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

{
  "id": "job_abc123xyz",
  "name": "royalty-text-processing",
  "status": "active",
  "progress": 45,
  "processedOn": "2024-01-15T10:30:00Z",
  "finishedOn": null,
  "failedReason": null,
  "data": {
    "fileName": "spotify_2024-01.csv",
    "royaltySource": "spotify",
    "accountingPeriod": "2024-01-01",
    "rowsProcessed": 45000,
    "rowsTotal": 100000
  }
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Get royalty processing job status Monitor the status and progress of a royalty file processing job. Provides real-time updates on processing progress, errors, and completion status. Authorization:

Required role: user or higher

Code Examples

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

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

import requests

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

data = response.json()
print(data)

curl -X GET https://api.royalti.io/file/processing/example-id \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization

string

header

required

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

Path Parameters

jobId

string

required

The processing job ID returned from file confirmation

Response

Success - Returns job details

string

Job ID

name

string

Job name/type

status

enum<string>

Current job status

Available options:

waiting,

active,

completed,

failed

progress

number

Processing progress (0-100)

Required range: 0 <= x <= 100

processedOn

string<date-time> | null

Timestamp when job started processing

finishedOn

string<date-time> | null

Timestamp when job finished

failedReason

string | null

Error message if job failed

data

object

Job-specific data and metadata

Get file download URL

Get Available Delivery Providers

​Description

​Code Examples

Authorizations

Path Parameters

Response

Description

Code Examples