Dashboard
APICustomer Rankings | Subscription Bot API
api.botsubscription.com
GET/v1/endpoint
AuthenticationBearer
Token
Stays in this tab. Required for this endpoint — the value below is what gets sent.
Examples
curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Customer Rankings

Rank customers by completed invoice revenue in a single currency. Use this report for your Telegram subscription bot or Discord subscription bot project.

GET/v2/projects/{project_id}/analytics/leaderboard

Authorization

Bearer API KeyRequired

API key scope: analytics:charts:read for restricted keys. Unrestricted project keys also support this endpoint.

Path Parameters

project_idstringrequired

Project UUID.

Query Parameters

fromstring

First UTC calendar day, YYYY-MM-DD; default to minus 29 days.

tostring

Last UTC calendar day inclusive, YYYY-MM-DD; default today.

currencystring

Optional 3–9 letters or digits, any case; default currency with most sales.

limitinteger

Digits-only integer from 1 to 100; default 10.

Dates must be real calendar days between 2000-01-01 and 2099-12-31, with from no later than to and at most 366 days inclusive. Unknown query parameters are rejected. There is no request body. See the shared analytics date, money, and cache rules.

Interpreting this report

Rows sort by revenue descending, then payment count, with stable user-ID ordering for ties. Totals cover all customers in the window, beyond the returned limit. Restricted keys receive ranks without user_id; unrestricted keys can receive identifiers. Even an anonymous rank reveals one customer's spend. Without a currency query, choose the currency with most sales, breaking ties alphabetically; an empty window then returns currency null.

Use the project API authentication reference for API-key setup.

Last updated: