Get Search Console performance
get_performanceUse this to retrieve Google Search Console search performance (clicks, impressions, CTR, average position) for one property. With no dimensions it returns property totals. Add dimensions to break results down by date, hour, query, page, country, device or searchAppearance, and filters to narrow to specific queries, pages, countries, devices or search appearances (for example mobile traffic to pages containing '/blog/'). search_type selects web (default), image, video, news, discover or googleNews results; discover and googleNews have no queries. For what happened in the last hours or days, group by hour (data_state 'hourly', last 10 days only, preliminary). Dates are Pacific Time. If no dates are given it uses the last 28 finalized days (or yesterday and today for hourly) and reports the exact dates it used. Covers one period at a time. Rows are bounded (default 20, max 100); page through with the returned cursor. Google returns only top rows for query/page breakdowns, so results are not guaranteed to be complete, and a missing row does not mean zero. Figures are observed values and do not identify causes. Read-only; cannot request indexing or change anything in Search Console.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Opaque cursor from coverage.nextCursor of the previous call with the same arguments. | |
| filters | No | All filters are combined with AND. | |
| end_date | No | Inclusive end date, YYYY-MM-DD (Pacific Time). Provide together with start_date. | |
| row_limit | No | Rows per call. Default 20, maximum 100. | |
| data_state | No | 'final' (default) returns finalized data only; 'all' includes recent preliminary data; 'hourly' is required (and implied) when grouping by hour. | |
| dimensions | No | Group results by these dimensions. Omit for a single totals row. 'hour' cannot be combined with 'date' and needs a range within the last 10 days. 'searchAppearance' lists search features such as review snippets or video and must be the only dimension; to break one feature down further, filter by searchAppearance instead. | |
| start_date | No | Inclusive start date, 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 report. Default 'web' (the combined 'All' tab). 'news' is the News tab in Search; 'googleNews' is news.google.com and the Google News app. | |
| connection_id | No | Optional: force a specific Google connection when the property is visible to several. | |
| include_totals | No | When grouping by dimensions, also fetch a separate property-level totals row. Default false. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | ||
| units | No | ||
| totals | No | ||
| request | No | ||
| coverage | No | ||
| property | No | ||
| freshness | No | ||
| requestId | No |