searchconsole.searchanalytics.query
Query Google Search Console performance data by date range and dimensions; apply filters to retrieve grouped search analytics rows as JSON.
Instructions
Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SearchAnalyticsQueryRequest object accepting aggregationType, dataState, dimensionFilterGroups, dimensions, endDate, rowLimit, searchType, startDate and 2 more fields; pass it via params or whole via body_file
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| siteUrl | Yes | [URL path segment] The site's URL, including protocol. For example: `http://www.example.com/`. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON SearchAnalyticsQueryRequest object. | |
| request_body | No | Request body of type SearchAnalyticsQueryRequest: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | No | ||
| metadata | No | ||
| responseAggregationType | No |