Skip to main content
GET
/
users
/
segmentation
Get User Segmentation
curl --request GET \
  --url https://ebn.telemetree.io/public-api/users/segmentation \
  --header 'x-api-key: <api-key>'
import requests

url = "https://ebn.telemetree.io/public-api/users/segmentation"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://ebn.telemetree.io/public-api/users/segmentation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ebn.telemetree.io/public-api/users/segmentation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://ebn.telemetree.io/public-api/users/segmentation"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://ebn.telemetree.io/public-api/users/segmentation")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://ebn.telemetree.io/public-api/users/segmentation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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