gsc_performance
Read Google Search Console performance (clicks, impressions, CTR, position) by query, page, dimension, or period comparison. Your own connected property; data is Google-finalized with a ~2-3 day lag. days/dates bound every action, and compare_periods contrasts the window with the one immediately before it. For diagnosis (cannibalization, CTR outliers) use gsc_insights rather than recomputing here. Already scoped to the connected workspace and its site; call directly, no domain or site parameter is needed. Cost: FREE - reads your connected/stored data, no AI credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Look-back window in days (defaults ~28). 1-90 for most actions; 7-90 for trend. | |
| depth | No | folder_rollup only: path depth to group by (1-3, default 1). | |
| limit | No | Row cap. top_queries/top_pages/dimension_breakdown default 50; compare_periods rows per period default 500. Ignored by query_page_matrix (use maxRows) and trend. | |
| action | Yes | Which operation to run. top_queries (top search queries); top_pages (top pages); dimension_breakdown (by device/country/date); query_page_matrix (cannibalization / query-to-page map); compare_periods (decay/growth vs the prior period); trend (daily clicks/impressions over time); discover_news (Discover / News / Image / Video surfaces); folder_rollup (performance by URL folder / site section); fresh (provisional today/yesterday numbers (hours-old data)). | |
| maxRows | No | query_page_matrix only: max query-page pairs (default 2000). | |
| surface | No | discover_news only: which surface (default discover). | |
| dimension | No | REQUIRED for dimension_breakdown (device|country|date). For compare_periods: query|page (default page). Ignored otherwise. | |
| filterPage | No | dimension_breakdown only: restrict to one exact page URL. | |
| filterQuery | No | dimension_breakdown only: restrict to one exact query. | |
| user_intent | No | Optional: one short sentence describing what the user is ultimately trying to achieve with this request. Used by SEOmatic to tailor answers and improve the product; never required. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||