Google Search Console API

GET/v1/google-search-console/site

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

5 tokens

Get one verified Search Console 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.get_site

Parameters1 field

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.

Response2 fields

site_urlstring

Verified property URL.

permission_levelstring

Access level for this property.

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/site"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "site_url": "sc-domain:example.com"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample property detail response.

site_details.json

{
  "site_url": "sc-domain:example.com",
  "permission_level": "siteOwner"
}

GET/v1/google-search-console/sitemap

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

5 tokens

Get details for one sitemap submitted to Search Console.

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

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

feed_pathstringRequired

Full sitemap URL for the property, for example https://example.com/sitemap.xml. Use an exact path from google-search-console.list_sitemaps when available.

Response14 fields

site_urlstring

Search Console property URL used for the request.

sitemapobject

12 fields

Sitemap details for the requested feed_path.

pathstring

Full sitemap URL path for the property.

last_submittedstring

Timestamp when the sitemap was last submitted.

is_pendingboolean

Whether Search Console is still processing the sitemap.

is_sitemaps_indexboolean

Whether this entry is a sitemap index.

sitemap_typestring

Sitemap type reported by Search Console.

last_downloadedstring

Timestamp when Google last downloaded the sitemap.

warningsstring

Warning count reported for the sitemap.

errorsstring

Error count reported for the sitemap.

contentsarrayitems

3 fields

Per-content-type submitted and indexed counts.

content_typestring

Sitemap content type reported by Search Console.

submittedstring

Number of submitted URLs of this content type, when available.

indexedstring

Number of indexed URLs of this content type, when available.

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/sitemap"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "site_url": "https://example.com/",
    "feed_path": "https://example.com/sitemap.xml"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample sitemap detail response.

sitemap_details.json

{
  "site_url": "https://example.com/",
  "sitemap": {
    "path": "https://example.com/sitemap.xml",
    "last_submitted": "2026-07-01T12:00:00.000Z",
    "is_pending": false,
    "is_sitemaps_index": false,
    "sitemap_type": "WEB",
    "last_downloaded": "2026-07-02T08:00:00.000Z",
    "warnings": "0",
    "errors": "0",
    "contents": [
      {
        "content_type": "web",
        "submitted": "120",
        "indexed": "110"
      }
    ]
  }
}

GET/v1/google-search-console/sitemaps

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

5 tokens

List sitemaps submitted for a Search Console 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.list_sitemaps

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

sitemap_indexstringOptional

Optional sitemap index URL. When set, only child sitemaps under that index are returned.

Response14 fields

site_urlstring

Search Console property URL used for the request.

sitemapsarrayitems

12 fields

Sitemaps submitted for the property.

pathstring

Full sitemap URL path for the property.

last_submittedstring

Timestamp when the sitemap was last submitted.

is_pendingboolean

Whether Search Console is still processing the sitemap.

is_sitemaps_indexboolean

Whether this entry is a sitemap index.

sitemap_typestring

Sitemap type reported by Search Console.

last_downloadedstring

Timestamp when Google last downloaded the sitemap.

warningsstring

Warning count reported for the sitemap.

errorsstring

Error count reported for the sitemap.

contentsarrayitems

3 fields

Per-content-type submitted and indexed counts.

content_typestring

Sitemap content type reported by Search Console.

submittedstring

Number of submitted URLs of this content type, when available.

indexedstring

Number of indexed URLs of this content type, when available.

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/sitemaps"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "site_url": "https://example.com/"
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample sitemap list for a property.

submitted_sitemaps.json

{
  "site_url": "https://example.com/",
  "sitemaps": [
    {
      "path": "https://example.com/sitemap.xml",
      "last_submitted": "2026-07-01T12:00:00.000Z",
      "is_pending": false,
      "is_sitemaps_index": false,
      "sitemap_type": "WEB",
      "last_downloaded": "2026-07-02T08:00:00.000Z",
      "warnings": "0",
      "errors": "0",
      "contents": [
        {
          "content_type": "web",
          "submitted": "120",
          "indexed": "110"
        }
      ]
    }
  ]
}

GET/v1/google-search-console/sites

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

5 tokens

List Search Console properties for this account.

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

Parameters0 fields

Response4 fields

sitesarrayitems

3 fields

Search Console properties for this account's Vee3-managed domains and sites added with google-search-console.add_site.

site_urlstring

Verified property URL. Either a URL-prefix property (for example https://example.com/) or a domain property (sc-domain:example.com).

permission_levelstring

Access level for this property.

is_defaultboolean

Whether this property is used when site_url is omitted on Search Console calls.

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/sites"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {

}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sample list of Search Console properties for this account.

verified_sites.json

{
  "sites": [
    {
      "site_url": "sc-domain:example.com",
      "permission_level": "siteOwner",
      "is_default": true
    },
    {
      "site_url": "sc-domain:another-example.com",
      "permission_level": "siteOwner",
      "is_default": false
    }
  ]
}

POST/v1/google-search-console/sites

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

10 tokens

Add a domain as a Google Search Console 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.add_site

Parameters1 field

site_urlstringRequired

Domain or property to add. The user or agent passes a hostname (example.com), a domain property (sc-domain:example.com), or a URL (https://example.com/).

Response8 fields

site_urlstring

Normalized Search Console domain property URL.

domain_namestring

Normalized domain name for the property.

statusstring

added, already_added, pending_verification (wait and retry), or needs_verification (add the DNS TXT record, then retry).

is_managedboolean

True when the domain is a Vee3-managed domain for this account.

messagestring

What happened and what the user or agent should do next.

dns_host_namestring

DNS host to create when status is needs_verification. Always @.

dns_record_typestring

DNS record type to create when status is needs_verification. Always TXT.

dns_tokenstring

DNS TXT record value to create when status is needs_verification.

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/sites"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "site_url": "example.com"
}

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

Example responses3 examples

200Vee3-managed domain added and verified.

managed_site_added.json

{
  "site_url": "sc-domain:example.com",
  "domain_name": "example.com",
  "status": "added",
  "is_managed": true,
  "message": "This Vee3-managed domain is now added to Google Search Console."
}

200Managed domain is still propagating DNS verification.

pending_verification.json

{
  "site_url": "sc-domain:example.com",
  "domain_name": "example.com",
  "status": "pending_verification",
  "is_managed": true,
  "message": "Google is still verifying this Vee3-managed domain. Wait a short time, then call google-search-console.add_site again with the same site_url."
}

200Unmanaged domain needs a DNS TXT record before it can be added.

needs_verification.json

{
  "site_url": "sc-domain:other-example.com",
  "domain_name": "other-example.com",
  "status": "needs_verification",
  "is_managed": false,
  "message": "This domain is not managed by Vee3. Create a DNS TXT record on the apex host @ with the token in dns_token. Wait for DNS to update, then call google-search-console.add_site again with the same site_url.",
  "dns_host_name": "@",
  "dns_record_type": "TXT",
  "dns_token": "google-site-verification=abc123"
}

DELETE/v1/google-search-console/sitemaps

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

10 tokens

Remove a sitemap URL from Search Console 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.delete_sitemap

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

feed_pathstringRequired

Full sitemap URL for the property, for example https://example.com/sitemap.xml. Use an exact path from google-search-console.list_sitemaps when available.

Response3 fields

site_urlstring

Search Console property URL used for the request.

feed_pathstring

Sitemap URL that was removed from Search Console.

deletedboolean

True when Search Console accepted the sitemap deletion.

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/sitemaps"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "site_url": "https://example.com/",
    "feed_path": "https://example.com/sitemap.xml"
}

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

Example responses1 example

200Sample successful sitemap deletion.

sitemap_deleted.json

{
  "site_url": "https://example.com/",
  "feed_path": "https://example.com/sitemap.xml",
  "deleted": true
}

PUT/v1/google-search-console/sitemaps

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

10 tokens

Submit a sitemap URL to Search Console 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.submit_sitemap

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

feed_pathstringRequired

Full sitemap URL for the property, for example https://example.com/sitemap.xml.

Response3 fields

site_urlstring

Search Console property URL used for the request.

feed_pathstring

Sitemap URL that was submitted.

submittedboolean

True when Search Console accepted the sitemap submission.

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/sitemaps"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "site_url": "https://example.com/",
    "feed_path": "https://example.com/sitemap.xml"
}

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

Example responses1 example

200Sample successful sitemap submission.

sitemap_submitted.json

{
  "site_url": "https://example.com/",
  "feed_path": "https://example.com/sitemap.xml",
  "submitted": true
}

POST/v1/google-search-console/url-inspection/inspect

https://api.vee3.io/v1/google-search-console/url-inspection/inspect

15 tokens

Inspect indexing status for a single URL in Search Console.

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

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

inspection_urlstringRequired

Fully qualified URL to inspect within the selected property.

language_codestringOptional

Optional BCP-47 language code for localized inspection results.

Response12 fields

site_urlstring

Verified property URL used for the inspection.

inspection_urlstring

URL that was inspected.

index_status_resultobject

9 fields

Indexing status details for the inspected URL.

verdictstring

Overall indexing verdict for the inspected URL.

coverage_statestring

Coverage state describing how the URL is indexed.

robots_txt_statestring

Whether robots.txt allows indexing of the URL.

indexing_statestring

Indexing state reported by Google.

last_crawl_timestring

Timestamp of the most recent crawl, when available.

page_fetch_statestring

Result of the most recent page fetch attempt.

google_canonicalstring

Canonical URL selected by Google, when available.

user_canonicalstring

Canonical URL declared on the page, when available.

crawled_asstring

User agent type used for the most recent crawl.

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/url-inspection/inspect"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "site_url": "https://example.com/",
    "inspection_url": "https://example.com/"
}

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

Example responses1 example

200Sample indexing result for an indexed page.

indexed_url.json

{
  "site_url": "https://example.com/",
  "inspection_url": "https://example.com/docs/getting-started",
  "index_status_result": {
    "verdict": "PASS",
    "coverage_state": "Submitted and indexed",
    "robots_txt_state": "ALLOWED",
    "indexing_state": "INDEXING_ALLOWED",
    "last_crawl_time": "2026-03-05T14:22:11Z",
    "page_fetch_state": "SUCCESSFUL",
    "google_canonical": "https://example.com/docs/getting-started",
    "user_canonical": "https://example.com/docs/getting-started",
    "crawled_as": "MOBILE"
  }
}

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