Segment Traffic and Engagement - Desktop

get

https://api.similarweb.com/v1/segment/{segment_id}/traffic-and-engagement/query

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

segment_id

string

required

Defaults to Add_Segment_ID

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

Query Params

api_key

string

required

Defaults to Add_Your_API_KEY

Your Similarweb API key.

start_date

string

Defaults to 2024-01

Start month (format: YYYY-MM)

end_date

string

Defaults to 2024-03

End month (format: YYYY-MM)

country

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.

metrics

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

granularity

string

required

Defaults to monthly

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

format

string

Defaults to json

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

mtd

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200