Segment Traffic and Engagement - Total

get

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

Returns traffic and engagement metrics for a predefined segment of a website, including visits, traffic share, unique visitors, bounce rate, and more — across both desktop and mobile traffic. Historical data goes back 37 months, depending on your subscription.

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.

metrics

string

required

Defaults to visits,share,unique-visitors

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

granularity

string

Defaults to monthly

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

format

string

Defaults to json

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

mtd

string

Defaults to false

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'.

Response

Language

Response

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

application/json

200200