Vee3

Query Google Search Console search analytics

Query Search Console performance metrics for a verified property.

← All Google Search Console endpoints · Capability overview

POST/v1/google-search-console/search-analytics/query

https://api.vee3.io/v1/google-search-console/search-analytics/query

20 tokens

Query Search Console performance metrics for a verified property.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

google-search-console.query_search_analytics
Parameters9 fields
site_urlstringOptional

Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.

start_datestringRequired

Inclusive range start date in YYYY-MM-DD format.

end_datestringRequired

Inclusive range end date in YYYY-MM-DD format.

dimensionsarrayOptional

Optional dimension names to group results. Supported values: date, query, page, country, device, searchAppearance, hour. Grouping by hour uses the hourly feed.

search_type"web" | "image" | "video" | "news" | "discover" | "googleNews"Optional

Search type filter. Defaults to web.

Default: "web"

row_limitintegerOptional

Maximum number of rows to return. Defaults to 1000.

Default: 1000 · min 1, max 25000

start_rowintegerOptional

Zero-based row offset for pagination. Defaults to 0.

Default: 0 · min 0

data_state"final" | "all" | "hourly_all"Optional

Whether to return only finalized data, all available daily data, or hourly data. Use hourly_all when grouping by hour. Defaults to final.

Default: "final"

dimension_filter_groupsarrayOptional

Optional filter groups matching the Google Search Console Search Analytics API shape. Each group contains filters that restrict which rows are returned.

Response11 fields
site_urlstring

Verified property URL that was queried.

rowsarrayitems
5 fields

Search analytics result rows.

keysstring[]

Dimension values for this row, in the same order as the requested dimensions.

clicksnumber

Click count for this row.

impressionsnumber

Impression count for this row.

ctrnumber

Click-through rate for this row.

positionnumber

Average position for this row.

response_aggregation_typestring

How rows were aggregated (for example auto or byProperty).

metadataobject
2 fields

Optional context about incomplete recent data. Present when Google is still collecting rows in the requested range.

first_incomplete_hourstring

First hour still being collected when grouping by hour, in America/Los_Angeles time.

first_incomplete_datestring

First date still being collected when grouping by date, in YYYY-MM-DD format.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, google_search_console_connection_required, google_search_console_connection_refresh_failed, google_search_console_connection_scopes_insufficient, google_search_console_upstream_error, google_search_console_site_not_found, google_search_console_rate_limited, dns_not_using_namecheap