Get User Segmentation

curl --request GET \
  --url https://ebn.telemetree.io/public-api/users/segmentation \
  --header 'x-api-key: <api-key>'

{
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "telegram_id": 123,
      "first_active_at": "2023-11-07T05:31:56Z",
      "total_events": 123,
      "total_sessions": 123,
      "last_active_at": "2023-11-07T05:31:56Z",
      "language": "<string>",
      "utm": "<string>",
      "is_premium": false,
      "country": "<string>",
      "city": "<string>",
      "username": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "device": "<string>",
      "brand": "<string>",
      "model": "<string>"
    }
  ],
  "status_code": 200,
  "message": "Success"
}

User API

Get User Segmentation

Description: Retrieves user information based on the specified filters.

Parameters:

language: The language. Use country code (ex: ‘en’, ‘ru’, ‘es’, etc.)
utm: The start parameter
is_premium: Whether the user is premium
country: The country
city: The city

Header

x-api-key: Your API Key (Dashboard->Settings)

Returns:

UserSegmentationResponse: The response containing the user segmentation data. It contains the following fields:
- data: The list of user segmentation entries. It contains the following fields:
  - telegram_id: The Telegram ID of the user.
  - language: The language of the user. Defaults to None.
  - utm: The start parameter of the user. Defaults to None.
  - is_premium: Whether the user is premium. Defaults to False.
  - first_active_at: The first active date of the user.
  - country: The country of the user. Defaults to None.
  - city: The city of the user. Defaults to None.
  - total_events: The total number of events from the user in your application.
  - total_sessions: The total number of sessions from the user in your application.
  - username: The username of the user. Defaults to None.
  - firstname: The first name of the user. Defaults to None.
  - lastname: The last name of the user. Defaults to None.
  - last_active_at: The last active date of the user.
  - device: The device of the user. Defaults to None.
  - brand: The brand of the user. Defaults to None.
  - model: The model of the user. Defaults to None.
- limit: The number of items per page.
- offset: The number of items to skip.
- status_code: The status code of the response.
- message: The message of the response.

Raises:

HTTPException: If an error occurs during the retrieval process.

GET

users

segmentation

Get User Segmentation

curl --request GET \
  --url https://ebn.telemetree.io/public-api/users/segmentation \
  --header 'x-api-key: <api-key>'

{
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "telegram_id": 123,
      "first_active_at": "2023-11-07T05:31:56Z",
      "total_events": 123,
      "total_sessions": 123,
      "last_active_at": "2023-11-07T05:31:56Z",
      "language": "<string>",
      "utm": "<string>",
      "is_premium": false,
      "country": "<string>",
      "city": "<string>",
      "username": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "device": "<string>",
      "brand": "<string>",
      "model": "<string>"
    }
  ],
  "status_code": 200,
  "message": "Success"
}

Authorizations

x-api-key

string

header

required

Your API Key (Dashboard->Settings)

Query Parameters

language

string | null

Language

utm

string | null

Start parameter

is_premium

boolean | null

Is premium user

country

string | null

Country

city

string | null

City

sort_by

enum<string> | null

default:curr_balance

Sort by

Available options:

is_premium,

curr_balance,

curr_volume,

total_events,

total_sessions,

language,

country,

city,

provider

sort_order

enum<string> | null

default:desc

Sort order

Available options:

asc,

desc

limit

integer

default:20

Number of items per page

Required range: x >= 1

offset

integer

default:0

Number of items to skip

Required range: x >= 0

Response

Successful Response

limit

integer

required

offset

integer

required

data

UserSegmentationEntry · object[]

required

Show child attributes

status_code

integer

default:200

message

string

default:Success

Get Retention Analysis Get User Aggregated Segmentation

Documentation Index

Authorizations

Query Parameters

Response