Get segments

Prev Next
Get
/query/segments

Retrieve a list of available data source logins and their segments

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Query parameters
json
Required
object
api_key
string

API key when not using an authorization header

ds_id
string Required

Data source ID

ds_users

List of data source login usernames to target (case-insensitive)

OneOf
string
string
array
array
string
cache_minutes
integer

Maximum allowed age of cache in minutes

Minimum60
Maximum1440
Responses
200

Segments retrieved successfully

Expand All
object
meta
object
request_id
string

API request ID

query
object
cache_minutes
integer | null

Requested maximum age of cache in minutes

data
Array of object
object
ds_user
string

Data source login username

display_name
string

Display name for login

cache_time
string (date-time) | null

ISO 8601 datetime for the last time the login data was fetched and cached

segments
Array of object
object
segment_id
string

Segment ID

segment_name
string

Segment name