Query Search Analytics
query_search_analyticsRun a raw Search Analytics query with full control over dimensions, filters, and dates to get custom search performance data from Search Console.
Instructions
Run a raw Search Analytics query with full control over the request.
This is the unmodified API method. For the common cases prefer top_queries, top_pages, performance_by_date, performance_by_country, performance_by_device, compare_periods or query_all_rows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | Inclusive end date, YYYY-MM-DD (PST). | |
| site_url | Yes | Property identifier. | |
| row_limit | No | 1 to 25,000. Page with start_row beyond that. | |
| start_row | No | Zero-based index of the first row to return. | |
| data_state | No | FINAL for finalised data only (default), ALL to include fresh partial data from the last ~2 days, HOURLY_ALL for hourly. | |
| dimensions | No | Dimensions to group by, in order. Results are keyed by the combination of these, in the order supplied. | |
| start_date | Yes | Inclusive start date, YYYY-MM-DD (PST). | |
| search_type | No | WEB, IMAGE, VIDEO, NEWS, DISCOVER or GOOGLE_NEWS. | WEB |
| aggregation_type | No | AUTO, BY_PROPERTY or BY_PAGE. Use AUTO when grouping or filtering by PAGE. | |
| dimension_filter_groups | No | Native filter groups, e.g. [{"groupType": "AND", "filters": [{"dimension": "QUERY", "operator": "CONTAINS", "expression": "buy"}]}] |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||