HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Query Segment Series

Returns the requested segment analytics series 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
required

The interval used to aggregate data within the series request.
If hourly is used, the timeframe cannot be longer than 7 days.
If daily is used, the timeframe cannot be longer than 60 days.
If monthly is used, the timeframe cannot be longer than 52 weeks.

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