Read new users and cumulative user counts for each time bucket. Use this report for your Telegram subscription bot or Discord subscription bot project.
GET/v2/projects/{project_id}/analytics/users
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.
intervalstring
day (default), week (ISO Monday start), or month (calendar).
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.
A user counts as new on the UTC day of first interaction. Imported users with no first-seen time can contribute to total users through their last-seen time. Placeholder users are excluded. Future days have zero new users and a flat cumulative count.