v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Conversion Analysis - Desktop

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.

get/{conversion_segment_id}/conversion-analysis/query

Path parameters

conversion_segment_idstring required

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

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring required

Start month (format: YYYY-MM)

end_datestring required

End month (format: YYYY-MM)

countrystring required

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.

granularitystring required

Supports monthly granularity only.

metricsstring required

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

channelstring

[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')

formatstring

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

Response

200

Example response

{
  "meta": {
    "request": {
      "segment": "digitalstorm.com%23",
      "granularity": "Monthly",
      "metrics": [
        "Visits"
      ],
      "format": "json",
      "start_date": "2020-01-01",
      "end_date": "2020-03-31",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2021-02-28",
    "device": "Desktop"
  },
  "segments": [
    {
      "date": "2020-01-01",
      "visits": 131239.0386587736,
      "converted_visits": 602,
      "conversion_rate": 0.004587049754038677,
      "stickiness": 1,
      "confidence": "High"
    }
  ]
}