vee3-io Google Search Console API
The google-search-console API from vee3-io — 6 operation(s) for google-search-console.
The google-search-console API from vee3-io — 6 operation(s) for google-search-console.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vee3-io:vee3-io-google-search-console-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Vee3 Io Google Search Console API
version: 0.1.0
description: 'Operations tagged google-search-console across 2 of this provider''s published API definitions: vee3-io.json, vee3-io-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: google-search-console
paths:
/v1/google-search-console/sites:
get:
tags:
- google-search-console
summary: List Google Search Console sites
description: List Search Console properties for this account.
operationId: list_google_search_console_sites_v1_google_search_console_sites_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListGoogleSearchConsoleSitesResult'
security:
- HTTPBearer: []
post:
tags:
- google-search-console
summary: Add Google Search Console site
description: Add a domain as a Google Search Console property.
operationId: add_google_search_console_site_v1_google_search_console_sites_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddGoogleSearchConsoleSiteRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AddGoogleSearchConsoleSiteResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v1/google-search-console/sitemaps:
get:
tags:
- google-search-console
summary: List Google Search Console sitemaps
description: List sitemaps submitted for a Search Console property.
operationId: list_google_search_console_sitemaps_v1_google_search_console_sitemaps_get
security:
- HTTPBearer: []
parameters:
- name: site_url
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Site Url
- name: sitemap_index
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sitemap Index
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListGoogleSearchConsoleSitemapsResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- google-search-console
summary: Submit Google Search Console sitemap
description: Submit a sitemap URL to Search Console for a verified property.
operationId: submit_google_search_console_sitemap_v1_google_search_console_sitemaps_put
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitGoogleSearchConsoleSitemapRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitGoogleSearchConsoleSitemapResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- google-search-console
summary: Delete Google Search Console sitemap
description: Remove a sitemap URL from Search Console for a verified property.
operationId: delete_google_search_console_sitemap_v1_google_search_console_sitemaps_delete
security:
- HTTPBearer: []
parameters:
- name: site_url
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Site Url
- name: feed_path
in: query
required: true
schema:
type: string
title: Feed Path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteGoogleSearchConsoleSitemapResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/google-search-console/sitemap:
get:
tags:
- google-search-console
summary: Get Google Search Console sitemap
description: Get details for one sitemap submitted to Search Console.
operationId: get_google_search_console_sitemap_v1_google_search_console_sitemap_get
security:
- HTTPBearer: []
parameters:
- name: site_url
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Site Url
- name: feed_path
in: query
required: true
schema:
type: string
title: Feed Path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetGoogleSearchConsoleSitemapResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/google-search-console/site:
get:
tags:
- google-search-console
summary: Get Google Search Console site
description: Get one Search Console property.
operationId: get_google_search_console_site_v1_google_search_console_site_get
security:
- HTTPBearer: []
parameters:
- name: site_url
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Site Url
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetGoogleSearchConsoleSiteResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/google-search-console/search-analytics/query:
post:
tags:
- google-search-console
summary: Query Google Search Console search analytics
description: Query Search Console performance metrics for a verified property.
operationId: query_google_search_console_search_analytics_v1_google_search_console_search_analytics_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryGoogleSearchConsoleSearchAnalyticsRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QueryGoogleSearchConsoleSearchAnalyticsResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v1/google-search-console/url-inspection/inspect:
post:
tags:
- google-search-console
summary: Inspect Google Search Console URL
description: Inspect indexing status for a single URL in Search Console.
operationId: inspect_google_search_console_url_v1_google_search_console_url_inspection_inspect_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InspectGoogleSearchConsoleUrlRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/InspectGoogleSearchConsoleUrlResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
GetGoogleSearchConsoleSitemapResult:
properties:
site_url:
type: string
title: Site Url
sitemap:
$ref: '#/components/schemas/GoogleSearchConsoleSitemapSummary'
additionalProperties: false
type: object
required:
- site_url
- sitemap
title: GetGoogleSearchConsoleSitemapResult
AddGoogleSearchConsoleSiteResult:
properties:
site_url:
type: string
title: Site Url
domain_name:
type: string
title: Domain Name
status:
type: string
title: Status
is_managed:
type: boolean
title: Is Managed
message:
type: string
title: Message
dns_host_name:
anyOf:
- type: string
- type: 'null'
title: Dns Host Name
dns_record_type:
anyOf:
- type: string
- type: 'null'
title: Dns Record Type
dns_token:
anyOf:
- type: string
- type: 'null'
title: Dns Token
additionalProperties: false
type: object
required:
- site_url
- domain_name
- status
- is_managed
- message
title: AddGoogleSearchConsoleSiteResult
InspectGoogleSearchConsoleUrlRequest:
properties:
site_url:
anyOf:
- type: string
- type: 'null'
title: Site Url
description: 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.
inspection_url:
type: string
title: Inspection Url
description: Fully qualified URL to inspect within the selected property.
language_code:
anyOf:
- type: string
- type: 'null'
title: Language Code
description: Optional BCP-47 language code for localized inspection results.
additionalProperties: false
type: object
required:
- inspection_url
title: InspectGoogleSearchConsoleUrlRequest
InspectGoogleSearchConsoleUrlResult:
properties:
site_url:
type: string
title: Site Url
inspection_url:
type: string
title: Inspection Url
index_status_result:
anyOf:
- $ref: '#/components/schemas/GoogleSearchConsoleIndexStatusResult'
- type: 'null'
additionalProperties: false
type: object
required:
- site_url
- inspection_url
title: InspectGoogleSearchConsoleUrlResult
SubmitGoogleSearchConsoleSitemapRequest:
properties:
site_url:
anyOf:
- type: string
- type: 'null'
title: Site Url
description: 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.
feed_path:
type: string
title: Feed Path
description: 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.
additionalProperties: false
type: object
required:
- feed_path
title: SubmitGoogleSearchConsoleSitemapRequest
GoogleSearchConsoleSitemapSummary:
properties:
path:
type: string
title: Path
last_submitted:
anyOf:
- type: string
- type: 'null'
title: Last Submitted
is_pending:
anyOf:
- type: boolean
- type: 'null'
title: Is Pending
is_sitemaps_index:
anyOf:
- type: boolean
- type: 'null'
title: Is Sitemaps Index
sitemap_type:
anyOf:
- type: string
- type: 'null'
title: Sitemap Type
last_downloaded:
anyOf:
- type: string
- type: 'null'
title: Last Downloaded
warnings:
anyOf:
- type: string
- type: 'null'
title: Warnings
errors:
anyOf:
- type: string
- type: 'null'
title: Errors
contents:
items:
$ref: '#/components/schemas/GoogleSearchConsoleSitemapContentSummary'
type: array
title: Contents
additionalProperties: false
type: object
required:
- path
title: GoogleSearchConsoleSitemapSummary
QueryGoogleSearchConsoleSearchAnalyticsRequest:
properties:
site_url:
anyOf:
- type: string
- type: 'null'
title: Site Url
description: 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_date:
type: string
title: Start Date
description: Inclusive range start date in YYYY-MM-DD format.
end_date:
type: string
title: End Date
description: Inclusive range end date in YYYY-MM-DD format.
dimensions:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Dimensions
description: 'Optional dimension names to group results. Supported values: date, query, page, country, device, searchAppearance, hour. Grouping by hour uses the hourly feed.'
search_type:
type: string
enum:
- web
- image
- video
- news
- discover
- googleNews
title: Search Type
description: Search type filter. Defaults to web.
default: web
row_limit:
type: integer
maximum: 25000.0
minimum: 1.0
title: Row Limit
description: Maximum number of rows to return. Defaults to 1000.
default: 1000
start_row:
type: integer
minimum: 0.0
title: Start Row
description: Zero-based row offset for pagination. Defaults to 0.
default: 0
data_state:
type: string
enum:
- final
- all
- hourly_all
title: Data State
description: 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_groups:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Dimension Filter Groups
description: Optional filter groups matching the Google Search Console Search Analytics API shape. Each group contains filters that restrict which rows are returned.
additionalProperties: false
type: object
required:
- start_date
- end_date
title: QueryGoogleSearchConsoleSearchAnalyticsRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
GoogleSearchConsoleSiteSummary:
properties:
site_url:
type: string
title: Site Url
permission_level:
anyOf:
- type: string
- type: 'null'
title: Permission Level
is_default:
type: boolean
title: Is Default
default: false
additionalProperties: false
type: object
required:
- site_url
title: GoogleSearchConsoleSiteSummary
GetGoogleSearchConsoleSiteResult:
properties:
site_url:
type: string
title: Site Url
permission_level:
anyOf:
- type: string
- type: 'null'
title: Permission Level
additionalProperties: false
type: object
required:
- site_url
title: GetGoogleSearchConsoleSiteResult
DeleteGoogleSearchConsoleSitemapResult:
properties:
site_url:
type: string
title: Site Url
feed_path:
type: string
title: Feed Path
deleted:
type: boolean
title: Deleted
additionalProperties: false
type: object
required:
- site_url
- feed_path
- deleted
title: DeleteGoogleSearchConsoleSitemapResult
AddGoogleSearchConsoleSiteRequest:
properties:
site_url:
type: string
title: Site Url
description: 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/).
additionalProperties: false
type: object
required:
- site_url
title: AddGoogleSearchConsoleSiteRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
QueryGoogleSearchConsoleSearchAnalyticsResult:
properties:
site_url:
type: string
title: Site Url
rows:
items:
$ref: '#/components/schemas/GoogleSearchConsoleSearchAnalyticsRow'
type: array
title: Rows
response_aggregation_type:
anyOf:
- type: string
- type: 'null'
title: Response Aggregation Type
metadata:
anyOf:
- $ref: '#/components/schemas/GoogleSearchConsoleSearchAnalyticsMetadata'
- type: 'null'
additionalProperties: false
type: object
required:
- site_url
title: QueryGoogleSearchConsoleSearchAnalyticsResult
GoogleSearchConsoleSearchAnalyticsMetadata:
properties:
first_incomplete_hour:
anyOf:
- type: string
- type: 'null'
title: First Incomplete Hour
first_incomplete_date:
anyOf:
- type: string
- type: 'null'
title: First Incomplete Date
additionalProperties: false
type: object
title: GoogleSearchConsoleSearchAnalyticsMetadata
SubmitGoogleSearchConsoleSitemapResult:
properties:
site_url:
type: string
title: Site Url
feed_path:
type: string
title: Feed Path
submitted:
type: boolean
title: Submitted
additionalProperties: false
type: object
required:
- site_url
- feed_path
- submitted
title: SubmitGoogleSearchConsoleSitemapResult
ListGoogleSearchConsoleSitesResult:
properties:
sites:
items:
$ref: '#/components/schemas/GoogleSearchConsoleSiteSummary'
type: array
title: Sites
additionalProperties: false
type: object
title: ListGoogleSearchConsoleSitesResult
GoogleSearchConsoleSearchAnalyticsRow:
properties:
keys:
items:
type: string
type: array
title: Keys
clicks:
anyOf:
- type: number
- type: 'null'
title: Clicks
impressions:
anyOf:
- type: number
- type: 'null'
title: Impressions
ctr:
anyOf:
- type: number
- type: 'null'
title: Ctr
position:
anyOf:
- type: number
- type: 'null'
title: Position
additionalProperties: false
type: object
title: GoogleSearchConsoleSearchAnalyticsRow
ListGoogleSearchConsoleSitemapsResult:
properties:
site_url:
type: string
title: Site Url
sitemaps:
items:
$ref: '#/components/schemas/GoogleSearchConsoleSitemapSummary'
type: array
title: Sitemaps
additionalProperties: false
type: object
required:
- site_url
title: ListGoogleSearchConsoleSitemapsResult
GoogleSearchConsoleIndexStatusResult:
properties:
verdict:
anyOf:
- type: string
- type: 'null'
title: Verdict
coverage_state:
anyOf:
- type: string
- type: 'null'
title: Coverage State
robots_txt_state:
anyOf:
- type: string
- type: 'null'
title: Robots Txt State
indexing_state:
anyOf:
- type: string
- type: 'null'
title: Indexing State
last_crawl_time:
anyOf:
- type: string
- type: 'null'
title: Last Crawl Time
page_fetch_state:
anyOf:
- type: string
- type: 'null'
title: Page Fetch State
google_canonical:
anyOf:
- type: string
- type: 'null'
title: Google Canonical
user_canonical:
anyOf:
- type: string
- type: 'null'
title: User Canonical
crawled_as:
anyOf:
- type: string
- type: 'null'
title: Crawled As
additionalProperties: false
type: object
title: GoogleSearchConsoleIndexStatusResult
GoogleSearchConsoleSitemapContentSummary:
properties:
content_type:
anyOf:
- type: string
- type: 'null'
title: Content Type
submitted:
anyOf:
- type: string
- type: 'null'
title: Submitted
indexed:
anyOf:
- type: string
- type: 'null'
title: Indexed
additionalProperties: false
type: object
title: GoogleSearchConsoleSitemapContentSummary
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- vee3-io.json
- vee3-io-openapi.json