search_analytics
Pull Google Search Console performance rows past the 25,000-row API cap and return a coverage block showing how row sums compare to property totals, writing large results to CSV or JSON.
Instructions
Pull Search Console performance rows, paging past the 25,000-row API cap until Google has no more rows (or maxRows is hit). Every response includes a coverage block: rows returned, pages fetched, whether the pull was truncated, property totals for the same window, and the share of clicks and impressions the rows account for. Read the coverage block and its notes before drawing conclusions. Large pulls are written to a CSV/JSON file and only a preview comes back inline.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | web | |
| endDate | Yes | YYYY-MM-DD | |
| filters | No | ANDed dimension filters. | |
| maxRows | No | Safety cap across all pages. | |
| siteUrl | Yes | Property exactly as Search Console lists it, e.g. "sc-domain:example.com" or "https://www.example.com/". | |
| dataState | No | "all" includes fresh, not-yet-final data. | final |
| startDate | Yes | YYYY-MM-DD | |
| dimensions | No | Breakdown dimensions. Each added dimension multiplies the row count. | |
| outputFile | No | Write all rows here (.csv or .json). Defaults to a temp CSV when rows exceed inlineRowLimit. | |
| previewRows | No | Rows to show inline when rows go to a file. | |
| inlineRowLimit | No | Return rows inline only up to this many. | |
| aggregationType | No | ||
| includeCoverage | No | Also pull property totals and compute coverage. |