Segment Traffic and Engagement - Desktop

Returns the traffic and engagement metrics of a predefined segment of a website on desktop devices. Includes visits, bounce rate, pages per visit, visit duration, pageviews, traffic share, unique visitors and confidence. Historical data goes back 37 months, depending on your subscription.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
DeviceGranularityMetrics
desktopmonthly,
weekly,
daily,
last 28 days (daily, weekly)
visits,
bounce-rate,
pages-per-visit,
visit-duration,
page-views,
traffic-share
desktopmonthlyunique visitors

To retrieve 'Last 28 days' data, remove the start_date & end_date parameters and set granularity to "daily" or "weekly".

📘

Price

Hits and data credits will be charged per metric requested, e.g - metrics=visits (1 data credits), metrics=visits, share (2 data credits) up to total of 7 metrics (7 data credits). Pulling this data is limited to 1 concurrent request.
For example:
Requesting 2 months, monthly granularity, 2 metrics - the price would be 4 data credits.

When Using MTD flag it will charge additional credits.

👍

How to find your Segment ID

  • Use the 'List Segments' endpoint OR
  • Visit an existing segment on the Similarweb platform, and extract the ID from the URL.

❗️

Limitations

  • The Unique Visitors metric is available in monthly granularity only.

  • Only individual segments are supported.

🚧

Premium Endpoint

This endpoint is available to customers with access to the Segment Analysis feature in their subscription. Reach out to your Account Manager for more information.

Path Params
string
required
Defaults to Add_Segment_ID

Enter a segment ID, as defined on the Similarweb platform. Without brackets {}.

Query Params
string
required
Defaults to Add_Your_API_KEY

Your Similarweb API key.

string
Defaults to 2024-01

Start month (format: YYYY-MM)

string
Defaults to 2024-03

End month (format: YYYY-MM)

string
required
Defaults to us

Country filter, as a 2-letter ISO country code, or "world" for worldwide. To see the country filters you have access to, please refer to the Check Capabilities endpoint.

string
required
Defaults to visits,share,pages-per-visit,page-views,bounce-rate,visit-duration,unique-visitors

List the metrics for which you would like to retrieve data for, separated by commas. Possible values: visits, share, pages-per-visit, page-views, bounce-rate , visit-duration and unique-visitors

string
required
Defaults to monthly

Set the granularity for the returned values. Possible values: 'daily', 'weekly' or 'monthly'.

string
Defaults to json

[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.

string
Defaults to false

[optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'. (2 hits total)

Response

Language