Get User Monthly Stats

curl --request GET \
  --url https://api.royalti.io/user/{id}/monthly \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.royalti.io/user/{id}/monthly', 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/user/{id}/monthly",
  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/user/{id}/monthly"

	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/user/{id}/monthly")

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

{
  "data": [
    {
      "Month": "2025-08-01",
      "Count": 903,
      "Royalty": 21.14823258699999,
      "Royalty_Share": 6.344469776099996
    },
    {
      "Month": "2025-07-01",
      "Count": 4997,
      "Royalty": 36.20617996492299,
      "Royalty_Share": 10.861853989476888
    }
  ],
  "meta": {
    "dateRange": {
      "startDate": "2025-01-01",
      "endDate": "2025-08-09"
    },
    "totalMonths": 8,
    "period": "ytd",
    "allTimeData": false,
    "filtersUsed": {
      "period": true,
      "customDates": false,
      "defaultApplied": false
    }
  }
}

GET

user

{id}

monthly

Get User Monthly Stats

curl --request GET \
  --url https://api.royalti.io/user/{id}/monthly \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.royalti.io/user/{id}/monthly', 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/user/{id}/monthly",
  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/user/{id}/monthly"

	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/user/{id}/monthly")

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

{
  "data": [
    {
      "Month": "2025-08-01",
      "Count": 903,
      "Royalty": 21.14823258699999,
      "Royalty_Share": 6.344469776099996
    },
    {
      "Month": "2025-07-01",
      "Count": 4997,
      "Royalty": 36.20617996492299,
      "Royalty_Share": 10.861853989476888
    }
  ],
  "meta": {
    "dateRange": {
      "startDate": "2025-01-01",
      "endDate": "2025-08-09"
    },
    "totalMonths": 8,
    "period": "ytd",
    "allTimeData": false,
    "filtersUsed": {
      "period": true,
      "customDates": false,
      "defaultApplied": false
    }
  }
}

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

Description

/user//monthly Description: The /user/{userId}/monthly endpoint allows users to retrieve monthly statistics like count and RoyaltyShare related to a specific user identified by their unique userId. By default, returns the last 12 months of data. Use optional query parameters to filter specific date ranges. Authorization:

Own resource: any authenticated user (self-access)
Other resources: admin or higher

Method: GET Path Parameter:

Parameter	Type	Description
userId	string	The unique identifier of the user.

Query Parameters:

Parameter	Type	Required	Description
period	string	No	Period preset: `all`, `last12months`, `ytd`, or `custom`. If `custom`, requires startDate/endDate.
startDate	string	No	Start date for filtering (YYYY-MM-DD format). Overrides period parameter.
endDate	string	No	End date for filtering (YYYY-MM-DD format). Overrides period parameter.

Parameter Priority:

Custom dates (startDate/endDate) override period parameter
Period presets are used if no custom dates provided
Defaults to last 12 months if neither provided

Examples:

/user/{id}/monthly - Returns last 12 months (default)
/user/{id}/monthly?period=all - Returns all historical data
/user/{id}/monthly?period=ytd - Returns year-to-date data
/user/{id}/monthly?period=last12months - Same as default
/user/{id}/monthly?startDate=2024-01-01&endDate=2024-12-31 - Custom range (ignores period)
/user/{id}/monthly?startDate=2024-06-01 - From June 2024 to today

See Sample Response Below

Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

User ID

Query Parameters

period

enum<string>

Period preset for filtering monthly data

Available options:

all,

last12months,

ytd,

custom

Example:

"ytd"

startDate

string<date>

Start date for filtering monthly data (YYYY-MM-DD format)

Example:

"2024-01-01"

endDate

string<date>

End date for filtering monthly data (YYYY-MM-DD format)

Example:

"2024-12-31"

Response

success

data

object[]

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Query Parameters

Response

Description

Code Examples