#### Returns the keywords driving search clicks for a specified domain

Constraints:

* _granularity_ supports only monthly granularity for last 3 months only **Output Data:** * _`keyword`_: A single keyword or name of a keyword group to analyze * _`clicks`_: The number of keyword search clicks to the website * _`traffic_share`_: The share of the traffic to the website * _`competition`_: Competition level for ad placement on the keyword. * _`primary_intent`_: An estimation of what peaople searching for this keywords are trying to acheive. * _`secondary_intent`_: Secondary intent for keyword search. * _`position`_: The keyword's latest universal position within the selected time range. Not avaialble for 'world' country. * _`serp_features`_: SERP features the domains rank for on the analyzed keyword * _`top_url`_: The site url with the highest organic position that ranks for the analyzed keyword { "endpoints": { "method": "get", "path": "v5/website-analysis/keywords/aggregated" }, "request": { "query": [ { "name": "domain", "description": "Website domain without 'www.' (e.g., 'example.com')", "isRequired": true, "valueType": "string", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "traffic_source", "description": "Traffic source to fetch data for — 'all', 'organic', or 'paid'", "isRequired": false, "value": "all", "valueType": "string", "options": { "enumValue": [ { "value": "all" }, { "value": "organic" }, { "value": "paid" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "start_date", "description": "Start date in 'YYYY-MM' or 'YYYY-MM-DD' format", "isRequired": false, "valueType": "string", "options": { "format": "date-time", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "end_date", "description": "End date in 'YYYY-MM' or 'YYYY-MM-DD' format", "isRequired": false, "valueType": "string", "options": { "format": "date-time", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "granularity", "description": "Time granularity — 'monthly', 'weekly' or 'daily'", "isRequired": false, "value": "monthly", "valueType": "string", "options": { "enumValue": [ { "value": "daily" }, { "value": "weekly" }, { "value": "monthly" } ], "example": "monthly", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "web_source", "description": "Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'", "isRequired": false, "value": "desktop", "valueType": "string", "options": { "enumValue": [ { "value": "desktop" }, { "value": "mobile_web" }, { "value": "total" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "country", "description": "Two-letter country code (e.g., 'us', 'gb', 'ww')", "isRequired": false, "value": "us", "valueType": "string", "options": { "example": "us", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "metrics", "description": "Comma-separated list of desired metrics. Default to all available metrics.", "isRequired": false, "valueType": "array", "options": { "enumValue": [ { "value": "clicks" }, { "value": "traffic_share" }, { "value": "competition" }, { "value": "primary_intent" }, { "value": "secondary_intent" }, { "value": "position" }, { "value": "serp_features" }, { "value": "top_url" }, { "value": "url_count" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "branded_type", "description": "Branded keyword type - 'all', 'branded', or 'non_branded'", "isRequired": false, "value": "all", "valueType": "string", "options": { "enumValue": [ { "value": "all" }, { "value": "branded" }, { "value": "non_branded" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "keywords_filter_rules", "description": "Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase).\nStructure: {[{\"type\": \"include | exclude\", \"match_type\": \"exact | phrase\", \"keywords\": [\"keyword1\", \"keyword2\"]}]}.\nExample: {[{\"type\": \"exclude\", \"match_type\": \"phrase\", \"keywords\": [\"brand name\", \"company\"]}, {\"type\": \"include\", \"match_type\": \"exact\", \"keywords\": [\"marketing\"]}]}", "isRequired": false, "valueType": "array", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "format", "description": "Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'", "isRequired": false, "value": "json", "valueType": "string", "options": { "enumValue": [ { "value": "json" }, { "value": "xml" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "limit", "description": "Number of items per page for pagination, default is 100", "isRequired": false, "valueType": "integer", "options": { "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "offset", "description": "Page number for pagination, starting from 1", "isRequired": false, "valueType": "integer", "options": { "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "asc", "description": "Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'", "isRequired": false, "valueType": "boolean", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "sort", "description": "Sort order for the results, applied on the properties of the returned record;", "isRequired": false, "valueType": "string", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ], "body": [], "header": [ { "name": "api-key", "isRequired": false, "valueType": "string", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ], "path": [], "contentType": "application/json", "graphqlQuery": "", "codeExamples": [], "auth": [], "_id": "69fc334096f4387d028053d4" }, "responses": [ { "statusCode": 200, "description": "Success", "contentType": "application/json", "body": [ { "name": "meta", "description": "", "isRequired": false, "value": "", "valueType": "object", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "query", "description": "", "isRequired": false, "value": "", "valueType": "object", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "limit", "description": "Number of items per page for pagination, default is 100", "isRequired": false, "value": "", "valueType": "integer", "options": { "minimum": -1, "maximum": 2147483647, "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "offset", "description": "Page number for pagination, starting from 1", "isRequired": false, "value": "", "valueType": "integer", "options": { "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "asc", "description": "Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'", "isRequired": false, "value": "", "valueType": "boolean", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "sort", "description": "Sort order for the results, applied on the properties of the returned record;", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ] }, { "name": "request", "description": "", "isRequired": false, "value": "", "valueType": "object", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "branded_type", "description": "Branded keyword type - 'all', 'branded', or 'non_branded'", "isRequired": false, "value": "all", "valueType": "string", "options": { "enumValue": [ { "value": "all" }, { "value": "branded" }, { "value": "non_branded" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "keywords_filter_rules", "description": "Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase).\nStructure: {[{\"type\": \"include | exclude\", \"match_type\": \"exact | phrase\", \"keywords\": [\"keyword1\", \"keyword2\"]}]}.\nExample: {[{\"type\": \"exclude\", \"match_type\": \"phrase\", \"keywords\": [\"brand name\", \"company\"]}, {\"type\": \"include\", \"match_type\": \"exact\", \"keywords\": [\"marketing\"]}]}", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "0", "description": "Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase).\nStructure: {[{\"type\": \"include | exclude\", \"match_type\": \"exact | phrase\", \"keywords\": [\"keyword1\", \"keyword2\"]}]}.\nExample: {[{\"type\": \"exclude\", \"match_type\": \"phrase\", \"keywords\": [\"brand name\", \"company\"]}, {\"type\": \"include\", \"match_type\": \"exact\", \"keywords\": [\"marketing\"]}]}", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "type", "description": "", "isRequired": false, "value": "include", "valueType": "string", "options": { "enumValue": [ { "value": "include" }, { "value": "exclude" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "match_type", "description": "", "isRequired": false, "value": "exact", "valueType": "string", "options": { "enumValue": [ { "value": "exact" }, { "value": "phrase" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "keywords", "description": "", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "allowUniqueItems": "true", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "0", "description": "", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "allowUniqueItems": "true", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ] } ] } ] }, { "name": "format", "description": "Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'", "isRequired": false, "value": "json", "valueType": "string", "options": { "enumValue": [ { "value": "json" }, { "value": "xml" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "domain", "description": "Website domain without 'www.' (e.g., 'example.com')", "isRequired": true, "value": "", "valueType": "string", "options": { "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "traffic_source", "description": "Traffic source to fetch data for — 'all', 'organic', or 'paid'", "isRequired": false, "value": "all", "valueType": "string", "options": { "enumValue": [ { "value": "all" }, { "value": "organic" }, { "value": "paid" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "start_date", "description": "Start date in 'YYYY-MM' or 'YYYY-MM-DD' format", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "format": "date-time", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "end_date", "description": "End date in 'YYYY-MM' or 'YYYY-MM-DD' format", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "format": "date-time", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "granularity", "description": "Time granularity — 'monthly', 'weekly' or 'daily'", "isRequired": false, "value": "daily", "valueType": "string", "options": { "enumValue": [ { "value": "daily" }, { "value": "weekly" }, { "value": "monthly" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "web_source", "description": "Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'", "isRequired": false, "value": "desktop", "valueType": "string", "options": { "enumValue": [ { "value": "desktop" }, { "value": "mobile_web" }, { "value": "total" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "country", "description": "Two-letter country code (e.g., 'us', 'gb', 'ww')", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "metrics", "description": "Comma-separated list of metrics: clicks, traffic_share, competition, primary_intent, secondary_intent, position, serp_features, top_url, url_count", "isRequired": false, "value": "clicks", "valueType": "array", "options": { "nullable": true, "enumValue": [ { "value": "clicks" }, { "value": "traffic_share" }, { "value": "competition" }, { "value": "primary_intent" }, { "value": "secondary_intent" }, { "value": "position" }, { "value": "serp_features" }, { "value": "top_url" }, { "value": "url_count" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "0", "description": "Comma-separated list of metrics: clicks, traffic_share, competition, primary_intent, secondary_intent, position, serp_features, top_url, url_count", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "enumValue": [ { "value": "clicks" }, { "value": "traffic_share" }, { "value": "competition" }, { "value": "primary_intent" }, { "value": "secondary_intent" }, { "value": "position" }, { "value": "serp_features" }, { "value": "top_url" }, { "value": "url_count" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ] } ] }, { "name": "status", "description": "", "isRequired": false, "value": "success", "valueType": "string", "options": { "enumValue": [ { "value": "success" }, { "value": "error" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "error_code", "description": "", "isRequired": false, "value": "", "valueType": "integer", "options": { "nullable": true, "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "error_message", "description": "", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "last_updated", "description": "", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "format": "date-time", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "data_type", "description": "", "isRequired": false, "value": "not_applicable", "valueType": "string", "options": { "enumValue": [ { "value": "not_applicable" }, { "value": "estimated" }, { "value": "verified" } ], "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ] }, { "name": "data", "description": "", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "0", "description": "", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "keyword", "description": "A single keyword or name of a keyword group to analyze", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "clicks", "description": "The number of keyword search clicks to the website", "isRequired": false, "value": "", "valueType": "number", "options": { "nullable": true, "format": "double", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "traffic_share", "description": "The share of the traffic to the website", "isRequired": false, "value": "", "valueType": "number", "options": { "nullable": true, "format": "double", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "competition", "description": "Competition level for ad placement on the keyword.", "isRequired": false, "value": "", "valueType": "integer", "options": { "nullable": true, "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "primary_intent", "description": "An estimation of what peaople searching for this keywords are trying to acheive.", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "secondary_intent", "description": "Secondary intent for keyword search.", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "position", "description": "The keyword's latest universal position within the selected time range. Not avaialble for 'world' country.", "isRequired": false, "value": "", "valueType": "integer", "options": { "nullable": true, "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "serp_features", "description": "SERP features the domains rank for on the analyzed keyword", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [ { "name": "0", "description": "SERP features the domains rank for on the analyzed keyword", "isRequired": false, "value": "", "valueType": "array", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ] }, { "name": "top_url", "description": "The site url with the highest organic position that ranks for the analyzed keyword", "isRequired": false, "value": "", "valueType": "string", "options": { "nullable": true, "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] }, { "name": "url_count", "description": "Number of URLs for the keyword", "isRequired": false, "value": "", "valueType": "integer", "options": { "nullable": true, "format": "int32", "xml": { "prefix": null }, "schemaNames": [] }, "complexItems": [], "items": [] } ] } ] } ] } ], "showBaseUrl": false, "showLanguageBox": false, "showRequestDescription": true, "showResponseDescription": true, "errorCodes": [], "statusCodes": [], "dataExample": [], "endpointSummary": [], "endpointSummaryShowParams": true, "errorCodesDisplayOnRight": true, "statusCodesDisplayOnRight": true }