Segment Marketing Channels - Desktop

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
DeviceGranularityMetrics
desktopmonthly,
weekly,
last 28 days (weekly)
by marketing channel (source type):
visits,
bounce-rate,
pages-per-visit,
visit-duration,
page-views

To retrieve ‘Last 28 days’ data, remove the start_date & end_date parameters and set granularity to “weekly”.

📘

Price

Data credits will be charged per metric and dates requested, e.g - metrics=visits (1 data credits), metrics=visits, share (2 data credits).
With each request you will receive a total of 8 marketing channels.

Pulling this data is limited to 1 concurrent request.
Example:
Requesting 2 months, monthly granularity, 2 metrics - the price would be 2x2x8 = 32 data 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.
🚧

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 similarweb_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,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.

string
required
Defaults to monthly

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

string
Defaults to json

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

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json