User API

Get User Event Segmentation

Description: This endpoint takes event name and filters and returns the users that match the specified filters.

Parameters:

period: The start and end dates. If not provided, the last 30 days will be used.
event_name: The event name. This is the name of the event that you want to segment.
language: The language. Use country code (ex: ‘en’, ‘ru’, ‘es’, etc.)
is_premium: Whether the user is premium
model: The model of the device that the user is using
os: The operating system of the device that the user is using
total_sessions: Filter on the minimum number of sessions
total_events: Filter on the minimum number of events
limit: The number of items per page (max 100)
offset: The number of items to skip (default 0)

Header

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

Returns:

UserEventSegmentationResponse: The response containing the user event segmentation data. It contains the following fields:
- data: The list of user event segmentation entries. It contains the following fields:
  - telegram_id: The Telegram ID of the user.
  - language: The language of the user. Defaults to None.
  - is_premium: Whether the user is premium. Defaults to False.
  - model: The model of the user. Defaults to None.
  - os: The operating system of the user. Defaults to None.
  - country: The country of the user. Defaults to None.
  - total_sessions: The total number of sessions of the user.
  - total_events: The total number of events of the user.
  - last_active_at: The last active date of the user.

GET

users

event-segmentation

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

{
  "status_code": 200,
  "message": "Success",
  "limit": 123,
  "offset": 123,
  "event_name": "<string>",
  "data": [
    {
      "telegram_id": 123,
      "language": "<string>",
      "is_premium": false,
      "model": "<string>",
      "country": "<string>",
      "os": "<string>",
      "total_sessions": 0,
      "total_events": 0,
      "last_active_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Your API Key (Dashboard->Settings)

Query Parameters

event_name

string

required

Event name

language

string | null

Language

is_premium

boolean | null

Is premium user

model

string | null

Model

string | null

Operating system

total_sessions

integer | null

Total sessions

total_events

integer | null

Total events

limit

integer

default:20

Number of items per page

Required range: 1 <= x <= 100

offset

integer

default:0

Number of items to skip

Required range: x >= 0

start

string | null

end

string | null

Response

200

application/json

Successful Response

limit

integer

required

offset

integer

required

event_name

string

required

data

object[]

required

status_code

integer

default:200

message

string

default:Success

Get User Aggregated Segmentation Get Realtime Users

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

{
  "status_code": 200,
  "message": "Success",
  "limit": 123,
  "offset": 123,
  "event_name": "<string>",
  "data": [
    {
      "telegram_id": 123,
      "language": "<string>",
      "is_premium": false,
      "model": "<string>",
      "country": "<string>",
      "os": "<string>",
      "total_sessions": 0,
      "total_events": 0,
      "last_active_at": "2023-11-07T05:31:56Z"
    }
  ]
}

User API

User API (Utils)

Events API

Funnels API

Retention API

Monthly Active Users API

Enterprise API

Telemetree Data Pipeline

Telemetree AI

Telemetree AI x TON Society

Get User Event Segmentation

Authorizations

Query Parameters

Response