User API
Get New And Active Users Count
User API
Get New And Active Users Count
Description: Retrieves new and active users count based on the specified mode, start and end dates.
Note: If you struggle to figure out the segments, please check out the helper function - get_segment_definition.
Parameters:
api_key: API key (https://app.telemetree.io/settings/project)group_by: List of fields to group byperiod: The start and end datesfilters: List of filters in Amplitude-like format
Returns:
UserCountResponse: The transformed user count data.
Raises:
HTTPException: If an error occurs during the retrieval process.
GET
/
users
Authorizations
x-api-key
string
headerrequiredYour API Key (Dashboard->Settings)
Query Parameters
group_by
enum<string>[] | null
List of fields to group by
Available options:
is_premium, language, referrer_type, os, brand, model, country, write_access start
string
requiredStart date in YYYYMMDD format
end
string
requiredEnd date in YYYYMMDD format
segments
string[] | null
Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]
Response
200 - application/json
data
object
requiredUser count data