Websites Dataset (Traffic and Engagement)

The Websites dataset offers a comprehensive analysis of website traffic and user engagement. It encompasses various metrics that provide insights into how visitors interact with websites, both on desktop and mobile platforms. This dataset is crucial for understanding website performance, audience behavior, and digital marketing effectiveness.

POST /batch/v4/request-report

Websites Dataset (Traffic and Engagement)

cURL

curl --request POST \
  --url https://api.similarweb.com/batch/v4/request-report \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "report_query": {
    "tables": [
      {
        "vtable": "traffic_and_engagement",
        "granularity": "monthly",
        "metrics": [],
        "filters": {
          "domains": [
            "nike.com"
          ],
          "countries": [
            "UK"
          ],
          "include_subdomains": true
        },
        "start_date": "2024-08",
        "end_date": "2024-08",
        "paging": {
          "sort_asc": "false",
          "sort": "<string>",
          "limit": 100,
          "offset": 0
        },
        "latest": true
      }
    ]
  },
  "delivery_information": {
    "webhook_url": "<string>",
    "delivery_method_params": {}
  }
}
'

200

"{\n    \"report_id\": \"c4asdf83d8-bf42-40a1-b3d2-8862832dbc55\",\n    \"status\": \"pending\"\n}"

Authorizations

api-key · string · header · required

Headers

api-key · string · required

Body

application/json

report_query · object · required

Show child attributes

delivery_information · object · required

Show child attributes

Response

200

application/json

200

report_id · string

Example:

"c4asdf83d8-bf42-40a1-b3d2-8862832dbc55"

status · string

Example:

"pending"