Compare Search Console performance
compare_performanceUse this when the user asks what changed between two periods, why traffic went up or down, or which pages, queries, countries or devices gained or lost. Compares clicks, impressions, CTR and average position for one property between a current period and the previous period (default), the same weekdays a year earlier, or explicit dates. Returns both totals with absolute and percent changes, the click change split into an impressions part and a CTR part, and, with a dimension, the top gainers and losers ranked by change in clicks or impressions. Dates are Pacific Time; with no dates the current period is the last 28 finalized days. Filters and search type apply to both periods. Changes are observed differences and do not identify causes. Read-only; does not change anything in Search Console.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| movers | No | Gainers and losers to return each. Default 10, maximum 50. | |
| filters | No | Applied to both periods, combined with AND. Same format as get_performance filters. | |
| rank_by | No | Rank movers by change in clicks (default) or impressions. | |
| end_date | No | Current period end, YYYY-MM-DD (Pacific Time). Provide together with start_date. | |
| dimension | No | Optional breakdown for top gainers and losers. Omit for totals only. | |
| compare_to | No | 'previous_period' (default) is the same number of days immediately before; 'previous_year' is 52 weeks earlier, so weekdays line up. Not used with explicit previous dates. | |
| data_state | No | 'final' (default) uses finalized data only; 'all' includes recent preliminary days. | |
| start_date | No | Current period start, YYYY-MM-DD (Pacific Time). Provide together with end_date. | |
| property_id | Yes | Exact property ID from list_properties, e.g. 'sc-domain:example.com' or 'https://example.com/'. | |
| search_type | No | Which results to compare. Default 'web'. discover and googleNews have no queries. | |
| connection_id | No | Optional: force a specific Google connection when the property is visible to several. | |
| previous_end_date | No | Optional explicit comparison period end, YYYY-MM-DD. | |
| previous_start_date | No | Optional explicit comparison period start, YYYY-MM-DD. Must end before the current period starts. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | ||
| units | No | ||
| losers | No | ||
| totals | No | ||
| gainers | No | ||
| request | No | ||
| coverage | No | ||
| property | No | ||
| freshness | No | ||
| requestId | No |