Getting Started

Sections

Run Elastic Report (POST)

Submit an Elastic report for execution. The same body as Validate, but this runs the report and charges credits. The result is delivered via the chosen delivery method.

Request body example

Request Body

 {
  "report_query": {
    "tables": [{ "vtable": "traffic_and_engagement", "granularity": "monthly", "metrics": ["all_traffic_visits", "category"], "filters": { "countries": ["US"] }, "start_date": "2026-01-01", "end_date": "2026-03-01" }],
    "query": { "and": [ { "ilike": ["category", "vehic*"] }, { "gt": ["all_traffic_visits", 1000000] } ] },
    "functional_metrics": [{ "function": "pop", "metrics": [["all_traffic_visits"]], "prefix_name": "pop" }]
  },
  "delivery_information": { "delivery_method": "download_link", "response_format": "csv" }
}

Response

200 OK

 
{
  "status": "processing",
  "report_id": "550e8400-e29b-41d4-a716-446655440000"
}

Header Parameters

api-keystring Required

Your Similarweb Batch API key.

Body Parameters

report_queryobject Required

The report definition.

Show child attributes

delivery_informationobject Required

Where and how the report is delivered.

Show child attributes

Response

200 OK

Object

Report accepted for processing.

Response Attributes

statusstring

Report status (pending, processing, completed, ...).

report_idstring

Id used to track and retrieve the report.

Sections

Run Elastic Report (POST)

Request body example

Response

Header Parameters

Body ParametersExpand all

Response

Response Attributes

Response

Ask an AI

Code with AI

Body Parameters