VOOZH about

URL: https://docs.similarweb.com/api-v5/api-reference/search-analysis-api/keywords-overview

⇱ Similarweb API V5 Documentation


Getting Started

Sections

Theme switcher

Keywords Overview

Get the full performance picture for a keyword or a saved keyword group: total search volume, clicks broken down by traffic type (organic, paid, PLA, search ads, SERP features), zero-click searches, SEO difficulty, paid competition, CPC bid range, AI Overview presence, and search intent split. Use it to size demand for a topic, score difficulty before targeting a term, or track how a keyword's volume and click distribution shifts month over month.

Output metrics:

  • volumeTotal search volume for the keyword in the selected country and period.
  • clicksTotal clicks across all SERP outcomes (organic + paid + features).
  • paid_clicksSum of search_ads_clicks and pla_clicks.
  • classic_organic_clicksClicks on standard organic blue-link results.
  • organic_serp_features_clicksClicks driven by organic SERP features (e.g., featured snippets, knowledge panels).
  • search_ads_clicksClicks on text-based search ads.pla_clicksClicks on Product Listing Ads (Shopping).
  • total_valid_serp_clicksAll measurable SERP clicks, used as the denominator for share calculations.
  • zero_clicksSearches that ended without a click on any result.
  • difficultySEO difficulty score, 0–100. Higher means harder to rank organically.
  • competitionPaid competition score, 0–100. Higher means more advertisers bidding.
  • ai_overviewArray of phrases that triggered an AI Overview on this keyword in the period. Empty or null if none.
  • cpc_low_bidLow end of the CPC bid range, in micros (divide by 1,000,000 for currency units).cpc_high_bidHigh end of the CPC bid range, in micros.
  • transactional_intent_volumeVolume share with transactional intent.
  • informational_intent_volumeVolume share with informational intent.
  • navigational_intent_volumeVolume share with navigational intent.
  • local_intent_volumeVolume share with local intent.
  • job_search_intent_volumeVolume share with job-search intent.

Constraints:

  • Granularity vs. lookback: monthly returns up to the last 3 complete months. daily returns the last 28 days only.
  • Daily date range: When granularity=daily, start_date and end_date must cover exactly the last 28 days, or both must be omitted (the API defaults to that window). Custom sub-ranges return a 400.
  • Country coverage: Country support varies per metric and per time period. Hit the describe endpoint to get the supported country list and date range before querying.
  • Web Source: desktop, mobile_web, or total. Some metrics (intent volumes, AI Overview, CPC) may return null on non-desktop sources.
  • Single keyword vs. group: Pass a single keyword string by default. To query a saved keyword group, pass the group name as keyword and set is_keyword_group=true. See Querying a keyword group.

How to find your Keyword List ID

  • Visit an existing keyword list on the Similarweb platform and extract the ID (e.g. 5dd82db8-3ec5-462c-9699-5aa37a1b71de) from the URL (e.g.
  • Send a request with is_keyword_group=true and the group name. A 200 response confirms the group exists and is accessible to your API key. A 404 or validation error means the name is wrong, the group is owned by a different account, or it hasn't been shared with your user.

Header Parameters

api-keystring

Query Parameters

keywordstring Required

A single keyword or name of a keyword group to analyze

granularitystring

Time granularity for the returned values

Enum values:
dailymonthly
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

web_sourcestring

The device/platform the traffic is coming from

Enum values:
desktopmobile_webtotal
metricsarray

Comma-separated list of metrics: clicks, paid_clicks, classic_organic_clicks, organic_serp_features_clicks, search_ads_clicks, pla_clicks, total_valid_serp_clicks, total_volume, zero_clicks_searches, difficulty, competition, ai_overview, cpc_low_bid, cpc_high_bid, transactional_intent_volume, informational_intent_volume, navigational_intent_volume, local_intent_volume, job_search_intent_volume

Enum values:
clickspaid_clicksclassic_organic_clicksorganic_serp_features_clickssearch_ads_clickspla_clickstotal_valid_serp_clicksvolumezero_clicksdifficulty
... 9 other enums
is_keyword_groupboolean

A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Sets how many results to return.

offsetinteger

Defines the number of results to skip

ascboolean

Orders the results by ascending or descending

Nullable:
True
sortstring

Selects a specific metric to order results by

Response

200
Object

OK

Response Attributes

metaobject
dataarray
Nullable:
True
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?