Skip to main content
GET
/
users
/
event-segmentation
Get User 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

​
os
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

Successful Response

​
limit
integer
required
​
offset
integer
required
​
event_name
string
required
​
data
UserEventSegmentationEntry · object[]
required
​
status_code
integer
default:200
​
message
string
default:Success