query_search_analytics
Retrieve Google Search Console analytics data to analyze keyword performance, clicks, impressions, CTR, and rankings for SEO optimization.
Instructions
Query Google Search Console search analytics data.
This is the main keyword research tool. Returns rows with clicks,
impressions, CTR, and average position.
Args:
site_url: The site URL as it appears in Search Console
(e.g. "https://mychefai.com" or "sc-domain:mychefai.com").
start_date: Start date in YYYY-MM-DD format.
end_date: End date in YYYY-MM-DD format.
dimensions: List of dimensions to group by. Options: query, page,
date, country, device, searchAppearance. Defaults to ["query"].
row_limit: Max rows to return (1-25000, default 1000).
start_row: Starting row offset for pagination (default 0).
dimension_filters: Optional list of filter objects. Each filter has:
- dimension: the dimension to filter on (e.g. "query", "page")
- operator: one of "contains", "equals", "notContains",
"notEquals", "includingRegex", "excludingRegex"
- expression: the filter value
Example: [{"dimension": "query", "operator": "contains",
"expression": "keto"}]
search_type: Type of search results. One of: web, image, video,
news, discover, googleNews. Default "web".
aggregation_type: How to aggregate results. One of: auto, byPage,
byProperty. If omitted, the API auto-selects.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_url | Yes | ||
| start_date | Yes | ||
| end_date | Yes | ||
| dimensions | No | ||
| row_limit | No | ||
| start_row | No | ||
| dimension_filters | No | ||
| search_type | No | web | |
| aggregation_type | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |