GET
/
users
/
segmentation
Get User Segmentation
curl --request GET \
  --url https://ebn.telemetree.io/public-api/users/segmentation \
  --header 'x-api-key: <api-key>'
{
  "status_code": 200,
  "message": "Success",
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "telegram_id": 123,
      "language": "<string>",
      "utm": "<string>",
      "is_premium": true,
      "first_active_at": "2023-11-07T05:31:56Z",
      "country": "<string>",
      "city": "<string>",
      "total_events": 123,
      "total_sessions": 123,
      "address": "<string>",
      "provider": "<string>",
      "curr_balance": 123,
      "curr_volume": 123
    }
  ]
}

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

​
wallet_connected
boolean | null

Is wallet connected

​
wallet_address
string | null

Wallet address

​
wallet_balance
number | null

Wallet balance

​
wallet_volume
number | null

Wallet volume

​
wallet_provider
string | null

Wallet provider

​
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
​
status_code
integer
default:200
​
message
string
default:Success