Query Search Console
query_search_consoleQueries Google Search Console live for the website: clicks, impressions, click-through rate and average position over any period of the last 16 months, grouped by query, page, country, device, date or search appearance, with filters on any of them (contains, equals, regex). It reads everything Search Console has at the moment of the call, where get_keyword_rankings and get_keyword_trends only cover the tracked keywords synced once a day. It also works on a website that has no plan yet, as soon as Search Console is connected for it. Examples: the queries of one page (dimensions ["query"], filter page equals its URL); queries ranking 5 to 15 with the most impressions (position_min 5, position_max 15, sort impressions); brand versus non-brand (filter query includingRegex or excludingRegex); daily clicks (dimensions ["date"]); pages losing traffic (call it for two periods and compare). Rows come back ordered by clicks, or by date when grouping by date only, unless sort is set. min_clicks, min_impressions, position_min, position_max and sort are applied to the top 25000 rows by clicks, and the result says when the property had more. Returns at most 500 rows per call (page with start_row). Search Console data lags 2 to 3 days. Limited to 200 calls per hour per website. When Search Console is not connected, the error gives the page where an admin connects it. Pass website_id when the account has several websites (see get_account).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | position: best first; clicks, impressions or ctr: highest first. Omit to keep Search Console's order. | |
| filters | No | Conditions a row must all satisfy. | |
| end_date | No | Last day, YYYY-MM-DD. Defaults to 3 days ago, the latest day with complete data. | |
| row_limit | No | How many rows to return. | |
| start_row | No | Zero-based offset, to page through the rows. | |
| data_state | No | final: only complete days. all: also the last days whose numbers may still change. | final |
| dimensions | No | How rows are grouped. Pass an empty array for the totals of the period. | |
| min_clicks | No | Only rows with at least this many clicks. | |
| start_date | No | First day, YYYY-MM-DD. Defaults to 27 days before end_date. | |
| website_id | No | Website id from get_account. Optional when the account has a single website. | |
| search_type | No | Which Google surface: web search (default), image, video, news, discover or googleNews. | web |
| position_max | No | Only rows whose average position is at most this value; must be >= position_min. | |
| position_min | No | Only rows whose average position is at least this value. | |
| min_impressions | No | Only rows with at least this many impressions. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | ||
| end_date | Yes | ||
| has_more | Yes | True when more rows exist: call again with start_row increased by row_count. | |
| site_url | Yes | Search Console property the rows come from. | |
| row_count | Yes | ||
| start_row | Yes | ||
| dimensions | Yes | ||
| start_date | Yes | ||
| website_id | Yes | Website the result belongs to. | |
| search_type | Yes | ||
| scanned_rows | No | Rows read from Search Console before the metric filters and sort were applied; absent without them. | |
| scan_truncated | No | True when the property has more rows than the scan read, so low-click rows may be missing. |