POST
/
batch
/
v4
/
request-report
Websites Dataset (Traffic and Engagement)
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",
        "filters": {
          "domains": [
            "nike.com"
          ],
          "countries": [
            "UK"
          ],
          "include_subdomains": true
        },
        "metrics": [],
        "start_date": "2024-08",
        "end_date": "2024-08",
        "paging": {
          "sort_asc": "false",
          "sort": "<string>",
          "limit": 100,
          "offset": 0
        },
        "latest": true
      }
    ]
  },
  "delivery_information": {
    "delivery_method": "download_link",
    "response_format": "json",
    "webhook_url": "<string>",
    "delivery_method_params": {}
  }
}'
"{\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

Response

200
application/json

200

The response is of type object.