HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Query Segment Values

Returns the requested segment analytics values data.

Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d

Scopes:
segments:read

Body Params
object
required
string
required
object
required
array of strings
required

List of statistics to query for.

statistics*
required

The timeframe to query for data within. Data is unavailable before June 1st, 2023. Please use a timeframe after this date. The max length a timeframe can be is 1 year

date-time
required
date-time
required
string

API filter string used to filter the query.
Allowed filters are segment_id.
Allowed operators are equals, any.
Only one filter can be used per attribute.
Max of 100 messages per ANY filter.

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials