VOOZH about

URL: https://docs.similarweb.com/api-v5/batch-api-general/batch-api-datasets/search-dataset

⇱ Similarweb API V5 Documentation

Getting Started

Sections

Theme switcher

Search Dataset

Discover the website keywords driving traffic to uncover search opportunities and build a winning digital marketing strategy. Keyword Analysis provides a deep-dive into any keyword on the web to discover the competitive landscape for any search term.

Historical Data Availability: Historical data is available from January 2023. Access depends on your subscription plan.

What you can track

  • Keyword metrics — Search volume, CPC, and difficulty scores.
  • Website keywords — Click metrics from search results for specific keywords leading to website visits.
  • Zero-click analysis — Searches that don’t result in clicks.
  • SERP features — Which features appear for keywords.
  • Device-specific data — Desktop vs. mobile keyword performance.
  • Competitive positioning — URLs and positions for organic and paid results.

Batch API and REST API use different keys. Ensure you're using your Batch API key.

Granularity Consistency: When generating a report, make sure all metrics are supported by the same granularity as the requested report.

Getting started

1. Authentication

CURL
 curl --location 'https://api.similarweb.com/batch/v5/request-report' \

--header 'api-key: {{API_KEY}}' \

--header 'Content-Type: application/json' \

--request POST \

--data body

Available tables (vtables)

Keywords (keywords)

Primary use case: Comprehensive keyword metrics including search volume, CPC, difficulty scores, and zero-click analysis.

Primary keys: keywords, countries

Metric
Description
Granularity

keyword_search_volume

Total searches for a keyword on Google.

Monthly, Weekly, Daily

all_keyword_cpc

Average CPC for the keyword (desktop + mobile).

Monthly

desktop_keyword_difficulty

Difficulty score (1-100) for ranking in top results.

Monthly

zero_clicks_share

Percentage of searches with no clicks.

Monthly

zero_clicks_latest_serp_date

Most recent SERP analysis date.

Monthly

Keywords example
 {

 "delivery_information": {"response_format": "csv", "delivery_method_params": {"retention_days": 60}},

 "report_query": {

 "tables": [{

 "vtable": "keywords",

 "granularity": "monthly",

 "filters": {"countries": ["WW","US"]},

 "metrics": ["all_keyword_cpc","keyword_search_volume","desktop_keyword_difficulty","zero_clicks_latest_serp_date","zero_clicks_share"],

 "start_date": "2025-06","end_date": "2025-06"

 }]

 }

}

Website Search / Keywords (website_search_keywords)

Primary use case: Click metrics from search results for specific keywords leading to website visits.

Primary keys: domains, keywords, countries

Metric
Description
Granularity

organic_desktop_site_clicks

Clicks generated from organic search results on desktop.

Daily, Weekly, Monthly

organic_mobile_site_clicks

Clicks generated from organic search results on mobile.

Daily, Weekly, Monthly

paid_desktop_site_clicks

Clicks generated from paid search results on desktop.

Daily, Weekly, Monthly

paid_mobile_site_clicks

Clicks generated from paid search results on mobile.

Daily, Weekly, Monthly

REST API endpoints via Batch API

You can access certain REST API endpoints through Batch API, leveraging Batch API’s asynchronous processing for REST endpoints.

Limitations

  • Supported granularities: daily, monthly.
  • Up to 100 keywords per request.

Available keyword analysis endpoints

Was this section helpful?
On this page
  • Search Dataset