Search performance overview
get_performance_overviewOne total for a property: clicks, impressions, CTR and average position.
Returns a single set of numbers for the whole date range, with no breakdown by query, page or anything else. Always read from the live Google API.
Without a filter this is the property-wide total, and it will not match a sum of rows from search_analytics_query. It is usually higher than the sum of rows by "query", because it also counts anonymized queries. It can be lower than the sum of rows by "page", because when two of your pages appear in one search result the page breakdown counts each page and the property total counts the result once.
With dimension_filter_groups it is the total for only the traffic that matches the filter. Example, one page's total: [{"groupType": "and", "filters": [{"dimension": "page", "operator": "equals", "expression": "https://example.com/pricing"}]}] For a page filter the result equals that page's row (or the sum of the matching rows) from search_analytics_query with dimensions ["page"]. A query filter never matches anonymized queries (Google's rule).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | ISO date (YYYY-MM-DD). Defaults to 3 days ago (GSC ~3-day lag). | |
| site_url | Yes | Property URL exactly as returned by list_sites. | |
| start_date | No | ISO date (YYYY-MM-DD). Defaults to 28 days ago. | |
| search_type | No | Default "web". Also "image", "video", "news", "discover", "googleNews". | web |
| dimension_filter_groups | No | Optional. Same shape and meaning as in search_analytics_query: a list of groups, each {"groupType": "and", "filters": [{"dimension", "operator", "expression"}]}. dimension is one of "query", "page", "country", "device", "searchAppearance". operator is one of "equals", "notEquals", "contains", "notContains", "includingRegex", "excludingRegex". Page filters need the full URL as Search Console reports it (scheme and host included). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||