v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Keywords Aggregated Overview

A top-level view of a keyword or list performance, including key insights such as volume & clicks, competitions metrics, and much more.

get/keywords/overview/aggregated

Query parameters

api_keystring required

Your Similarweb API key.

formatstring

[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.

start_datestring

[optional] Start date (format: YYYY-MM), Starting from 2023-01 (28 days of data returned if start_date and end_date are not given)

end_datestring

[optional] End date (format: YYYY-MM), Starting from 2023-01 (28 days of data returned if start_date and end_date are not given)

countrystring required

Country filter, as a 2-letter ISO country code, or "world" for worldwide. To see the country filters you have access to, please refer to the Check Capabilities endpoint.

web_sourcestring

[optional] Sets the web source type (supports: Desktop, Mobile Web, Total). Default (if not given) is Total

keywordstring

Enter a keyword of interest or a keyword list by ID, without brackets {}.

is_keyword_groupboolean

A keywords group is being provided (true or false)

Response

200

Example response

{
  "meta": {
    "request": {
      "keyword": "phone",
      "web_source": "Total",
      "format": "json",
      "start_date": "2025-03-01",
      "end_date": "2025-03-31",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2025-04-30"
  },
  "data": [
    {
      "volume": 202550,
      "volume_change": 0.15535287507771636,
      "clicks": 69832.46915627256,
      "clicks_change": 0.741581915183103,
      "zero_clicks_searches": 0.8902,
      "zero_clicks_searches_change": -0.003916303009958664,
      "classic_organic_traffic_share": 0.8044512715466311,
      "organic_serp_features_traffic_share": 0.17535653662284967,
      "pla_traffic_share": 0.02019219183051917,
      "organic_difficulty": 90,
      "paid_competition": 100,
      "primary_intent": "transactional",
      "cpc_range_low_bid": 3.33,
      "cpc_range_high_bid": 12.12,
      "min_total_spent": 5537.965457917492,
      "max_total_spent": 20156.19860359159
    }
  ]
}