v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Visits - Desktop

Returns the estimated number of desktop visits to a domain. Historical data goes back 37 months, depending on your subscription.

get/{domain_name}/traffic-and-engagement/visits

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'.

statestring

[optional] Select the US state on which to filter the data. Only available when country = US, leave blank otherwise! Supported states: az, ca, ga, fl, il, ma, mi, nj, ny, nc, oh, pa, tx, va, wa.

main_domain_onlystring

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

formatstring

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

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'.

engaged_onlystring

[optional] When 'true', the data is filtered by 'engaged visits' only.

Response

200

Example response

{
  "meta": {
    "request": {
      "granularity": "Monthly",
      "state": "az",
      "format": "json",
      "domain": "cnn.com",
      "start_date": "2023-01-01",
      "end_date": "2023-03-31",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2023-05-31",
    "device": "Desktop"
  },
  "visits": [
    {
      "date": "2023-01-01",
      "visits": 4054433.3700886075
    }
  ]
}