Google Search Console API
The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)
Data & analytics#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)
Endpoints 11
searchanalytics
- POSTQuery your data with filters and parameters that you define
/webmasters/v3/sites/:siteUrl/searchAnalytics/queryQuery your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range…
sitemaps
- GETRetrieves information about a specific sitemap.
/webmasters/v3/sites/:siteUrl/sitemaps/:feedpathRetrieves information about a specific sitemap. - PUTSubmits a sitemap for a site.
/webmasters/v3/sites/:siteUrl/sitemaps/:feedpathSubmits a sitemap for a site. - DELETEDeletes a sitemap from the Sitemaps report
/webmasters/v3/sites/:siteUrl/sitemaps/:feedpathDeletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap. - GETLists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index…
/webmasters/v3/sites/:siteUrl/sitemaps?sitemapIndex=stringLists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
sites
- GETRetrieves information about specific site.
/webmasters/v3/sites/:siteUrlRetrieves information about specific site. - PUTAdds a site to the set of the user's sites in Search Console.
/webmasters/v3/sites/:siteUrlAdds a site to the set of the user's sites in Search Console. - DELETERemoves a site from the set of the user's Search Console sites.
/webmasters/v3/sites/:siteUrlRemoves a site from the set of the user's Search Console sites. - GETLists the user's Search Console sites.
/webmasters/v3/sitesLists the user's Search Console sites.
urlInspection.index
- POSTIndex inspection.
/v1/urlInspection/index:inspectIndex inspection.
urlTestingTools.mobileFriendlyTest
- POSTRuns Mobile-Friendly Test for a given URL.
/v1/urlTestingTools/mobileFriendlyTest:runRuns Mobile-Friendly Test for a given URL.
API details
- Base URL
https://searchconsole.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 11 operations on 7 pathsGET 4POST 3PUT 2DELETE 2
- Main resources
- sitemaps 4sites 4searchanalytics 1urlInspection.index 1urlTestingTools.mobileFriendlyTest 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Google Search Console API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Google Search Console API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Query your data with filters and parameters that you define” (POST /webmasters/v3/sites/:siteUrl/searchAnalytics/query), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Google Search Console API?
The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone) It is listed under Data & analytics and has 11 endpoints.
Who publishes the Google Search Console API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Google Search Console API?
Requests go to https://searchconsole.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Google Search Console API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Google Search Console API have?
11 operations on 7 paths (4 GET, 3 POST, 2 PUT, 2 DELETE). The largest groups are sitemaps, sites, searchanalytics, urlInspection.index.
Is forking the Google Search Console API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.