Segment Traffic and Engagement
Header Parameters
api-keystring
Query Parameters
segmentstring Required
Segment ID to analyze
granularitystring
Time granularity for the returned values
Enum values:
dailyweeklymonthlycountrystring
Two-letter country code (e.g., 'us', 'gb', 'ww')
start_datestring
Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago
end_datestring
End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago
web_sourcestring
The device/platform the traffic is coming from
Enum values:
desktoptotalmetricsarray
Comma-separated list of metrics: visits, bounce_rate, page_views, average_visit_duration, pages_per_visit, share, unique_visitors
Style
form
Enum values:
visitsbounce_ratepage_viewsaverage_visit_durationpages_per_visitshareunique_visitorsmtdboolean
When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'
formatstring
Format in which the reply should be returned
Enum values:
jsonxmlResponse
200
Object
OK
Response Attributes
metaobject
Show child attributes
dataarray | null
Show child attributes
Was this section helpful?
Response
Was this section helpful?