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 verified 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.

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"Optional

Whether to return only finalized data or all available data. 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.

Response8 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).

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

Example request

Python

import requests

url = "https://api.vee3.io/v1/google-search-console/search-analytics/query"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "site_url": "https://example.com/",
    "start_date": "2026-03-01",
    "end_date": "2026-03-07",
    "dimensions": ["query"],
    "row_limit": 25
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample search analytics rows grouped by query.

query_dimension_rows.json

{
  "site_url": "https://example.com/",
  "rows": [
    {
      "keys": [
        "vee3 agent tools"
      ],
      "clicks": 42,
      "impressions": 1200,
      "ctr": 0.035,
      "position": 8.4
    },
    {
      "keys": [
        "mcp capabilities"
      ],
      "clicks": 18,
      "impressions": 640,
      "ctr": 0.028125,
      "position": 11.2
    }
  ],
  "response_aggregation_type": "auto"
}