v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Company Analysis - Desktop

Returns the digital reach and performance at a company level, for desktop traffic.

get/{company_id}/desktop-traffic-and-engagement/query

Path parameters

company_idstring required

Enter a company 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) 2022-01

end_datestring required

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.

metricsstring required

List the metrics you would like to retrieve data for, separated by commas. Possible values: visits, pages-per-visit, page-views, bounce-rate and visit-duration.

granularitystring required

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

formatstring

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

Response

200

Example response

{
  "meta": {
    "request": {
      "company_name": "cnn",
      "granularity": "Monthly",
      "metrics": [
        "Visits"
      ],
      "company_id": "4ca1f0bf-2771-4690-ae7e-d8042fee2433",
      "format": "json",
      "start_date": "2021-07-01",
      "end_date": "2021-09-30",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2021-10-31",
    "device": "Desktop"
  },
  "companies": [
    {
      "date": "2021-07-01",
      "visits": 176335996.80185258,
      "bounce_rate": 0.49012062253009125,
      "pages_per_visit": 2.6724902377481756,
      "visit_duration": 362.2025053184621,
      "page_views": 471256230.0165446,
      "unique_visitors": 23902045.291410744
    }
  ]
}