search_analytics
Queries Google Search Console performance data to analyze clicks, impressions, CTR, and average position for specified URLs, dates, dimensions, and filters.
Instructions
Queries Search Console search-performance data (the Performance report).
Args:
site_url: Property to query, exactly as it appears in Search Console,
e.g. sc-domain:example.com or https://example.com/.
start_date: Inclusive start date, YYYY-MM-DD.
end_date: Inclusive end date, YYYY-MM-DD.
dimensions: Group-by dimensions. Any of: query, page, country, device,
date, searchAppearance. Omit for account totals.
search_type: One of web, image, video, news, discover, googleNews.
row_limit: Rows to return, 1-25000 (default 1000).
start_row: Zero-based offset for pagination (default 0).
dimension_filters: Optional list of filters, each a dict with keys
dimension, operator (equals, contains, notContains,
includingRegex, excludingRegex), and expression.
data_state: final (default, finalized data) or all (includes
fresh, not-yet-finalized data).
Returns:
The raw API response, including a rows list with keys, clicks,
impressions, ctr, and position.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_url | Yes | ||
| start_date | Yes | ||
| end_date | Yes | ||
| dimensions | No | ||
| search_type | No | web | |
| row_limit | No | ||
| start_row | No | ||
| dimension_filters | No | ||
| data_state | No | final |