API explorer
Getting Started

Sections

API explorer

Theme switcher

Segments Marketing Channels

Header Parameters

api-keystring

Query Parameters

segmentstring Required

Segment ID to analyze

granularitystring

Time granularity for the returned values

Enum values:
weeklymonthly
countrystring

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:
desktoptotal
metricsarray

Comma-separated list of metrics: visits, bounce_rate, page_views, average_visit_duration, pages_per_visit

Enum values:
visitsbounce_ratepage_viewsaverage_visit_durationpages_per_visit
data_versionstring

Optional data version name for accessing alternative data versions

formatstring

Format in which the reply should be returned

Enum values:
jsonxml

Response

200
Object

OK

Response Attributes

metaobject
dataarray | null
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?