Segment Marketing Channels - Desktop

get

https://api.similarweb.com/v1/segment/{segment_id}/marketing-channels/query

Returns traffic and engagement data per traffic channel for a predefined website segment. Desktop devices only. 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 similarweb_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,pages-per-visit,page-views,bounce-rate,visit-duration

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

granularity

string

required

Defaults to monthly

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

format

string

Defaults to json

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

Response

Language

Response

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

application/json

200200