search_analytics
Query Google Search Console search analytics data for one property. Retrieve clicks, impressions, CTR, and position by query, page, country, device, or date with filters and pagination.
Instructions
Query search analytics for one property.
site_url: property from list_sites. start_date/end_date: YYYY-MM-DD (default: last 28 days ending 3 days ago). dimensions: subset of query, page, country, device, date, searchAppearance. filters: list of {dimension, operator, expression} with operators equals, notEquals, contains, notContains, includingRegex, excludingRegex. search_type: web, image, video, news, discover, googleNews. data_state: final or all. row_limit: 1..25000; start_row: pagination offset.
Returns TSV rows plus a metadata block (date range, rows returned, more_may_exist: true when rows == row_limit, so paginate with start_row).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | ||
| end_date | No | ||
| site_url | Yes | ||
| row_limit | No | ||
| start_row | No | ||
| data_state | No | final | |
| dimensions | No | ||
| start_date | No | ||
| search_type | No | web |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |