Search performance (custom)
search_performanceFlexible Google Search Console query. Group by query, page, country, device or date; filter by text; optionally compare with the previous period.
Input 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. Compared with the same number of days right before it. Default 28. | |
| site | Yes | The site to read. Accepts "example.com", "https://example.com/" or "sc-domain:example.com"; a subdomain like "blog.example.com" narrows a domain property to that subdomain. Call list_sites if unsure. | |
| 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 | Only pages whose URL contains this text. | |
| filter_query | No | Only queries containing this text. | |
| compare_previous | No | Add each row's change against the previous period of the same length. Default false. |