grr
api reference · v1

Every Search Console method, from the index.

All 11 methods of the Search Console API, rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Flags are kebab-cased parameter names: userId is --user-id.

11 methods · v1 · revision 20260923

searchconsole.searchanalytics

1 method

searchconsole.searchanalytics.query

POST

grr searchconsole searchanalytics query webmasters/v3/sites/{siteUrl}/searchAnalytics/query

Query 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 of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which

Parameter Type Required Repeated Location Description Enum values
siteUrl string yes — path The site's URL, including protocol. For example: `http://www.example.com/`. —

https://www.googleapis.com/auth/webmasters.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

grr searchconsole searchanalytics query 
grr searchconsole searchanalytics query --site-url <site-url> --body-file ./body.json

searchconsole.sitemaps

4 methods

searchconsole.sitemaps.delete

DELETE

grr searchconsole sitemaps delete webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}

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

Parameter Type Required Repeated Location Description Enum values
feedpath string yes — path The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. —
siteUrl string yes — path The site's URL, including protocol. For example: `http://www.example.com/`. —

https://www.googleapis.com/auth/webmasters least privilege

1 scope
  • https://www.googleapis.com/auth/webmasters

grr searchconsole sitemaps delete 
grr searchconsole sitemaps delete --feedpath <feedpath> --site-url <site-url>

searchconsole.sitemaps.get

GET

grr searchconsole sitemaps get webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}

Retrieves information about a specific sitemap.

Parameter Type Required Repeated Location Description Enum values
feedpath string yes — path The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. —
siteUrl string yes — path The site's URL, including protocol. For example: `http://www.example.com/`. —

https://www.googleapis.com/auth/webmasters.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

grr searchconsole sitemaps get 
grr searchconsole sitemaps get --feedpath <feedpath> --site-url <site-url>

searchconsole.sitemaps.list

GET

grr searchconsole sitemaps list webmasters/v3/sites/{siteUrl}/sitemaps

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).

Parameter Type Required Repeated Location Description Enum values
sitemapIndex string — — query A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`. —
siteUrl string yes — path The site's URL, including protocol. For example: `http://www.example.com/`. —

https://www.googleapis.com/auth/webmasters.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

grr searchconsole sitemaps list 
grr searchconsole sitemaps list --site-url <site-url>

searchconsole.sitemaps.submit

PUT

grr searchconsole sitemaps submit webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}

Submits a sitemap for a site.

Parameter Type Required Repeated Location Description Enum values
feedpath string yes — path The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. —
siteUrl string yes — path The site's URL, including protocol. For example: `http://www.example.com/`. —

https://www.googleapis.com/auth/webmasters least privilege

1 scope
  • https://www.googleapis.com/auth/webmasters

grr searchconsole sitemaps submit 
grr searchconsole sitemaps submit --feedpath <feedpath> --site-url <site-url> --body-file ./body.json

searchconsole.sites

4 methods

searchconsole.sites.add

PUT

grr searchconsole sites add webmasters/v3/sites/{siteUrl}

Adds a site to the set of the user's sites in Search Console.

Parameter Type Required Repeated Location Description Enum values
siteUrl string yes — path The URL of the site to add. —

https://www.googleapis.com/auth/webmasters least privilege

1 scope
  • https://www.googleapis.com/auth/webmasters

grr searchconsole sites add 
grr searchconsole sites add --site-url <site-url> --body-file ./body.json

searchconsole.sites.delete

DELETE

grr searchconsole sites delete webmasters/v3/sites/{siteUrl}

Removes a site from the set of the user's Search Console sites.

Parameter Type Required Repeated Location Description Enum values
siteUrl string yes — path The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`. —

https://www.googleapis.com/auth/webmasters least privilege

1 scope
  • https://www.googleapis.com/auth/webmasters

grr searchconsole sites delete 
grr searchconsole sites delete --site-url <site-url>

searchconsole.sites.get

GET

grr searchconsole sites get webmasters/v3/sites/{siteUrl}

Retrieves information about specific site.

Parameter Type Required Repeated Location Description Enum values
siteUrl string yes — path The URI of the property as defined in Search Console. **Examples:** `http://www.example.com/` or `sc-domain:example.com`. —

https://www.googleapis.com/auth/webmasters.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

grr searchconsole sites get 
grr searchconsole sites get --site-url <site-url>

searchconsole.sites.list

GET

grr searchconsole sites list webmasters/v3/sites

Lists the user's Search Console sites.

No parameters.

https://www.googleapis.com/auth/webmasters.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

grr searchconsole sites list 
grr searchconsole sites list

searchconsole.urlInspection.index

1 method

searchconsole.urlInspection.index.inspect

POST

grr searchconsole urlInspection index inspect v1/urlInspection/index:inspect

Index inspection.

No parameters.

https://www.googleapis.com/auth/webmasters.readonly least privilege

2 scopes
  • https://www.googleapis.com/auth/webmasters
  • https://www.googleapis.com/auth/webmasters.readonly

grr searchconsole urlInspection index inspect 
grr searchconsole urlInspection index inspect --body-file ./body.json

searchconsole.urlTestingTools.mobileFriendlyTest

1 method

searchconsole.urlTestingTools.mobileFriendlyTest.run

POST

grr searchconsole urlTestingTools mobileFriendlyTest run v1/urlTestingTools/mobileFriendlyTest:run

Runs Mobile-Friendly Test for a given URL.

No parameters.

no scope — a public endpoint that needs no authorisation

grr searchconsole urlTestingTools mobileFriendlyTest run 
grr searchconsole urlTestingTools mobileFriendlyTest run --body-file ./body.json