Google

Search Console API

View Google Search Console data for your verified sites.

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

View Google Search Console data for your verified sites.

Endpoints 9

searchanalytics

  • POSTwebmasters.searchanalytics.query/sites/:siteUrl/searchAnalytics/query?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringQuery 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

  • GETwebmasters.sitemaps.list/sites/:siteUrl/sitemaps?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=string&sitemapIndex=stringLists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
  • GETwebmasters.sitemaps.get/sites/:siteUrl/sitemaps/:feedpath?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringRetrieves information about a specific sitemap.
  • PUTwebmasters.sitemaps.submit/sites/:siteUrl/sitemaps/:feedpath?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringSubmits a sitemap for a site.
  • DELETEwebmasters.sitemaps.delete/sites/:siteUrl/sitemaps/:feedpath?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringDeletes a sitemap from this site.

sites

  • GETwebmasters.sites.list/sites?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringLists the user's Search Console sites.
  • GETwebmasters.sites.get/sites/:siteUrl?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringRetrieves information about specific site.
  • PUTwebmasters.sites.add/sites/:siteUrl?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringAdds a site to the set of the user's sites in Search Console.
  • DELETEwebmasters.sites.delete/sites/:siteUrl?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringRemoves a site from the set of the user's Search Console sites.

API details

Base URL
https://www.googleapis.com/webmasters/v3
Authentication
OAuth 2.0 (implicit flow) with 2 scopes
OAuth 2.0 (authorization code flow) with 2 scopes
Operations
9 operations on 5 pathsGET 4PUT 2DELETE 2POST 1
Main resources
sitemaps 4sites 4searchanalytics 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Search Console API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Search Console API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “webmasters.searchanalytics.query” (POST /sites/:siteUrl/searchAnalytics/query?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Search Console API?

View Google Search Console data for your verified sites. It is listed under Data & analytics and has 9 endpoints.

Who publishes the 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 Search Console API?

Requests go to https://www.googleapis.com/webmasters/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Search Console API?

It accepts 2 methods: OAuth 2.0 (implicit flow) with 2 scopes; OAuth 2.0 (authorization code flow) with 2 scopes.

How many endpoints does the Search Console API have?

9 operations on 5 paths (4 GET, 2 PUT, 2 DELETE, 1 POST). The largest groups are sitemaps, sites, searchanalytics.

Is forking the Search Console API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.