Search Console performance data
gsc_queryThe Search Console performance report, as Google returns it: clicks, impressions, ctr and average position, broken down by any dimensions (date, hour, query, page, country, device, searchAppearance), for any search type (web, image, video, news, googleNews, discover), with filters. Use this for any analysis of the customer's own Search Console data: top queries, top pages, countries, devices, daily trends, a single page's queries, a query's pages, branded versus non-branded, regex filters. Up to 5,000 rows per call; page through with startRow. ctr is a fraction, so 0.05 is 5%. Search Console data runs about 2 days behind.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | No | Optional. A property exactly as gsc_properties lists it, such as sc-domain:example.com or https://example.com/. Omit for the property this brand is connected with. | |
| type | No | Search type. Default web. | |
| endDate | No | YYYY-MM-DD. Default 2 days ago, the newest day with complete data. | |
| filters | No | Filters, all of which must match. Example: [{"dimension":"query","operator":"contains","expression":"pricing"}]. | |
| rowLimit | No | Rows to return. Default 1000, maximum 5000. | |
| startRow | No | Zero-based row to start from, for paging. Default 0. | |
| dataState | No | final is complete data only (default). all includes the newest, still-changing days. | |
| startDate | No | YYYY-MM-DD. Default 28 days before endDate. Search Console keeps about 16 months. | |
| dimensions | No | What to group by, in order. Empty gives one total row. hour needs dataState hourly_all and a range of 10 days at most. | |
| aggregationType | No | How Google aggregates. Default auto. byProperty is only valid when page is not a dimension. |