query_search_analytics
Query Google Search Console Search Analytics rows by dimensions, filters, dates, and search type to analyze clicks, impressions, CTR, and position.
Instructions
Search Analytics rows with any dimensions and filters. The general-purpose query tool.
Args: site_url: property (sc-domain:example.com, https://example.com/ or just example.com). days / start_date / end_date: range; explicit dates (YYYY-MM-DD) win over days. dimensions: comma list of query, page, country, device, date, searchAppearance, hour. search_type: web, image, video, news, discover, googleNews. query_filter: a term in ANY language; case-insensitive, and matches its common spellings (ی/ي, ک/ك, half-space, vowel marks, Persian/Arabic digits, е/ё). query_regex / query_regex_exclude: raw RE2 regex (see build_query_regex for a safe one). page_filter: substring of the page URL; page_exact: the exact URL; page_filter_exclude: substring to leave out; page_regex: RE2 regex on the URL. country: ISO-3166-1 alpha-3 (IRN, USA…); device: DESKTOP, MOBILE, TABLET. data_state: all (matches the UI, default) or final. group_variants: merge spelling variants of the same query (only when dimensions=query). level: standard or loose grouping (loose also merges spacing and accent differences). sort_by: clicks, impressions, ctr, position — applied to the fetched rows; Google itself always returns the top rows by clicks. limit: rows shown. max_rows: rows fetched.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | ||
| level | No | standard | |
| limit | No | ||
| device | No | ||
| country | No | ||
| sort_by | No | clicks | |
| end_date | No | ||
| max_rows | No | ||
| site_url | Yes | ||
| data_state | No | ||
| dimensions | No | query | |
| page_exact | No | ||
| page_regex | No | ||
| start_date | No | ||
| page_filter | No | ||
| query_regex | No | ||
| search_type | No | web | |
| query_filter | No | ||
| group_variants | No | ||
| search_appearance | No | ||
| page_filter_exclude | No | ||
| query_regex_exclude | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |