Search performance (custom)
search_performanceRead-onlyIdempotent
Generate custom Search Console reports grouping by query, page, country, device, or date; filter and sort data, then compare against the previous period to reveal performance changes.
Instructions
Custom Search Console report when site_overview is not specific enough: group by query, page, country, device or date (up to two at once), filter by query or page text, sort, and optionally add the change against the previous period. Returns a table with clicks, impressions, CTR and position per row. Read-only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Length of the period in days, 7 to 480, ending about 3 days ago because Google data lags. It is compared with the same number of days right before it. Default 28. | |
| site | Yes | The Search Console property to read. Accepts "example.com", "https://example.com/" or "sc-domain:example.com". Call list_sites first if unsure which properties exist. | |
| limit | No | Maximum rows to return, 1 to 200. Default 25. | |
| sort_by | No | Which number to sort rows by, highest first (position: best first). Default clicks. | clicks |
| group_by | No | One or two dimensions to break the numbers down by, e.g. ["query"] or ["page", "query"]. Default ["query"]. | |
| filter_page | No | Keep only pages whose URL contains this text, e.g. "/blog/". | |
| filter_query | No | Keep only search queries that contain this text (case-insensitive), e.g. a brand or product name. | |
| compare_previous | No | Add each row's change against the previous period of the same length. Default false. |