--- updatedAt: 2025-11-07T23:55:48.000Z agentTools: projectIndex: https://developers.similarweb.com/llms.txt --- # 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.
Device Granularity Metrics
desktop, mobile, or total Monthly or last 28 days "volume",\ "volume\_change",\ "clicks",\ "clicks\_change",\ "zero\_clicks\_searches",\ "zero\_clicks\_searches\_change",\ "classic\_organic\_traffic\_share",\ "organic\_serp\_features\_traffic\_share",\ "text\_ads\_traffic\_share",\ "pla\_traffic\_share",\ "organic\_difficulty",\ "paid\_competition",\ "primary\_intent",\ "cpc\_range\_low\_bid",\ "cpc\_range\_high\_bid",\ "min\_total\_spent",\ "max\_total\_spent"
To retrieve 'Last 28 days' data, remove the start\_date & end\_date parameters. > 📘 Price > > **17 data credits** per keyword or keyword group. > 👍 How to find your Keyword List ID > > * Insert your API key into the following endpoint, then use the JSON result: "response" > "keyword\_groups" > "id" to retrieve the keyword groups created or shared in your account.\ > .\ > To retrieve only the Keyword Lists created by your user, add the parameter "\&userOnlyGroups=true". > * 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. > ❗️ Currently, this endpoint only supports a single month of data. Hence, start\_date and end\_date must be equal # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "keyword-search-v4", "version": "4.0" }, "servers": [ { "url": "https://api.similarweb.com/v4/keyword-search/" } ], "security": [ {} ], "paths": { "/keywords/overview/aggregated": { "get": { "summary": "Keywords Aggregated Overview", "description": "A top-level view of a keyword or list performance, including key insights such as volume & clicks, competitions metrics, and much more.", "operationId": "keywords-aggregated-overview", "parameters": [ { "name": "api_key", "in": "query", "description": "Your Similarweb API key.", "required": true, "schema": { "type": "string", "default": "Add_Your_API_KEY" } }, { "name": "format", "in": "query", "description": "[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "[optional] Start date (format: YYYY-MM), Starting from 2023-01 (28 days of data returned if start_date and end_date are not given)", "schema": { "type": "string", "default": "2023-01" } }, { "name": "end_date", "in": "query", "description": "[optional] End date (format: YYYY-MM), Starting from 2023-01 (28 days of data returned if start_date and end_date are not given)", "schema": { "type": "string", "default": "2023-01" } }, { "name": "country", "in": "query", "description": "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.", "required": true, "schema": { "type": "string", "default": "us" } }, { "name": "web_source", "in": "query", "description": "[optional] Sets the web source type (supports: Desktop, Mobile Web, Total). Default (if not given) is Total", "schema": { "type": "string", "default": "Total" } }, { "name": "keyword", "in": "query", "description": "Enter a keyword of interest or a keyword list by ID, without brackets {}.", "schema": { "type": "string" } }, { "name": "is_keyword_group", "in": "query", "description": "A keywords group is being provided (true or false)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "VIEW EXAMPLE RESPONSE": { "value": "{\n\"meta\": {\n\"request\": {\n\"keyword\": \"phone\",\n\"is_keyword_group\": false,\n\"web_source\": \"Total\",\n\"format\": \"json\",\n\"start_date\": \"2025-03-01\",\n\"end_date\": \"2025-03-31\",\n\"country\": \"us\"\n},\n\"status\": \"Success\",\n\"last_updated\": \"2025-04-30\"\n},\n\"data\": [\n{\n\"volume\": 202550,\n\"volume_change\": 0.15535287507771636,\n\"clicks\": 69832.46915627256,\n\"clicks_change\": 0.741581915183103,\n\"zero_clicks_searches\": 0.8902,\n\"zero_clicks_searches_change\": -0.003916303009958664,\n\"classic_organic_traffic_share\": 0.8044512715466311,\n\"organic_serp_features_traffic_share\": 0.17535653662284967,\n\"text_ads_traffic_share\": 0,\n\"pla_traffic_share\": 0.02019219183051917,\n\"organic_difficulty\": 90,\n\"paid_competition\": 100,\n\"primary_intent\": \"transactional\",\n\"cpc_range_low_bid\": 3.33,\n\"cpc_range_high_bid\": 12.12,\n\"min_total_spent\": 5537.965457917492,\n\"max_total_spent\": 20156.19860359159\n}\n]\n}" } }, "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "request": { "type": "object", "properties": { "keyword": { "type": "string", "example": "phone" }, "is_keyword_group": { "type": "boolean", "example": false, "default": true }, "web_source": { "type": "string", "example": "Total" }, "format": { "type": "string", "example": "json" }, "start_date": { "type": "string", "example": "2025-03-01" }, "end_date": { "type": "string", "example": "2025-03-31" }, "country": { "type": "string", "example": "us" } } }, "status": { "type": "string", "example": "Success" }, "last_updated": { "type": "string", "example": "2025-04-30" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "volume": { "type": "integer", "example": 202550, "default": 0 }, "volume_change": { "type": "number", "example": 0.15535287507771636, "default": 0 }, "clicks": { "type": "number", "example": 69832.46915627256, "default": 0 }, "clicks_change": { "type": "number", "example": 0.741581915183103, "default": 0 }, "zero_clicks_searches": { "type": "number", "example": 0.8902, "default": 0 }, "zero_clicks_searches_change": { "type": "number", "example": -0.003916303009958664, "default": 0 }, "classic_organic_traffic_share": { "type": "number", "example": 0.8044512715466311, "default": 0 }, "organic_serp_features_traffic_share": { "type": "number", "example": 0.17535653662284967, "default": 0 }, "text_ads_traffic_share": { "type": "integer", "example": 0, "default": 0 }, "pla_traffic_share": { "type": "number", "example": 0.02019219183051917, "default": 0 }, "organic_difficulty": { "type": "integer", "example": 90, "default": 0 }, "paid_competition": { "type": "integer", "example": 100, "default": 0 }, "primary_intent": { "type": "string", "example": "transactional" }, "cpc_range_low_bid": { "type": "number", "example": 3.33, "default": 0 }, "cpc_range_high_bid": { "type": "number", "example": 12.12, "default": 0 }, "min_total_spent": { "type": "number", "example": 5537.965457917492, "default": 0 }, "max_total_spent": { "type": "number", "example": 20156.19860359159, "default": 0 } } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```