Dashboard
APIRetention Cohorts | 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_•••'

Retention Cohorts

Read monthly cohorts based on each user's first membership start. Use this report for your Telegram subscription bot or Discord subscription bot project.

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

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.

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

The window selects whole cohort months, even when it begins mid-month. Every selected month appears, including empty cohorts. Each cohort has 12 month-end cells; future cells are null, and rates are also null for an empty cohort. A user can leave and return, so cells need not decrease. Current membership rows and rewritten expiry dates limit historical accuracy.

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

Last updated: