Conversion Analysis - Desktop

get

https://api.similarweb.com/v1/segment/{conversion_segment_id}/conversion-analysis/query

Returns the conversion rates of predefined conversion segments on desktop devices. Includes visits, converted visits, conversion rate, stickiness and confidence. Historical data goes back 37 months, depending on your subscription.

Path Params

conversion_segment_id

string

required

Defaults to Add_Conversion_Segment_ID

Enter a conversion 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

required

Defaults to 2023-01

Start month (format: YYYY-MM)

end_date

string

required

Defaults to 2023-03

End month (format: YYYY-MM)

country

string

required

Defaults to us

Country filter, as a 2-letter ISO country code. To see the country filters you have access to, please refer to the Check Capabilities endpoint. Worldwide country filter not yet supported.

granularity

string

required

Defaults to monthly

Supports monthly granularity only.

metrics

string

required

Defaults to visits,converted-visits,conversion-rate,stickiness

List of metrics you would like to retrieve data for, separated by commas. Possible values: visits, converted-visits, conversion-rate and stickiness.

channel

string

Defaults to total

[optional] Select which marketing channels you'd like to get data for. Possible values: total, direct, paid-search, organic-search, display-ads, referrals, mail, social (Default: 'total')

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