Segments Analysis
Header Parameters
api-keystring
Query Parameters
segmentstring Required
Segment ID to analyze
web_sourcestring
Specifies the web source device type
Default value
total
Enum values:
desktopmobile_webtotalmetricsarray
Comma-separated list of desired metrics. Default to all available metrics.
Enum values:
visitsbounce_ratepage_viewsvisit_durationpages_per_visitshareunique_visitorsmtdboolean
If true, sets end_date to the latest available day (month-to-date).
Default is false.
countrystring
Two-letter country code (for example, us, gb, ww)
formatstring
Format in which the reply should be returned.
Default value
json
Enum values:
jsonxmlstart_datestring
Start date in YYYY-MM or YYYY-MM-DD format
end_datestring
End date in YYYY-MM or YYYY-MM-DD format
granularitystring
Time granularity
Default value
Monthly
Enum values:
DailyWeeklyMonthlyResponse
200
Object
Successful response
Response Attributes
metaobject
Metadata for segment traffic and engagement response
Show child attributes
dataarray
Nullable:
True
Show child attributes
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?