v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Pages Per Visit by Marketing Channel - Desktop

Returns the estimated pages per visit by marketing channel (Organic Search, Paid Search, Direct, Display Ads, E-Mail, Referrals and Social) on desktop devices.

get/{domain_name}/traffic-sources/engagement-metrics/pages-per-visit

Path parameters

domain_namestring required

Enter website of interest, without 'www.' or brackets {}.

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring

Start month (format: YYYY-MM)

end_datestring

End month (format: YYYY-MM)

countrystring required

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.

granularitystring required

Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.

main_domain_onlystring

[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').

formatstring

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

mtdstring

[optional] 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

200

Example response

{
  "meta": {
    "request": {
      "granularity": "Monthly",
      "format": "json",
      "domain": "cnn.com",
      "start_date": "2023-01-01",
      "end_date": "2023-03-31",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2023-05-31"
  },
  "data": [
    {
      "source_type": "Email",
      "values": [
        {
          "date": "2023-01-01",
          "value": 2.3481843986105284
        }
      ]
    }
  ]
}