Skip to main content
GET
Get User Segmentation

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