Google Search Console

App · 10 actions

Read search performance, inspect indexed URLs, and manage Search Console properties and sitemaps.

Actions

ActionWhat it does
Add propertyAdd a property to your Search Console account.
Delete sitemapDelete sitemap in Google Search Console.
Get propertyGet site in Google Search Console.
Get sitemapGet sitemap in Google Search Console.
Inspect URLInspect url in Google Search Console.
List propertiesList sites in Google Search Console.
List sitemapsList sitemaps in Google Search Console.
Query search analyticsQuery search analytics in Google Search Console.
Remove propertyRemove a property from your account.
Submit sitemapSubmit sitemap in Google Search Console.

Add property

Add a property to your Search Console account. Ownership verification is separate.

Inputs

Site urlsite_urltextRequired
Site url.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete sitemap

Delete sitemap in Google Search Console.

Inputs

Site urlsite_urltextRequired
Site url.
Sitemap urlsitemap_urltextRequired
Sitemap url.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get property

Get site in Google Search Console.

Inputs

Site urlsite_urltextRequired
Site url.

Outputs

Response.

dataobject
Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "permissionLevel": "SITE_PERMISSION_LEVEL_UNSPECIFIED",
    "siteUrl": "Example"
  },
  "has_more": false,
  "next_cursor": null
}

Get sitemap

Get sitemap in Google Search Console.

Inputs

Site urlsite_urltextRequired
Site url.
Sitemap urlsitemap_urltextRequired
Sitemap url.

Outputs

Response.

dataobject
Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "contents": [],
    "errors": "Example",
    "isPending": false,
    "isSitemapsIndex": false,
    "lastDownloaded": "Example",
    "lastSubmitted": "Example",
    "path": "Example",
    "type": "NOT_SITEMAP",
    "warnings": "Example"
  },
  "has_more": false,
  "next_cursor": null
}

Inspect URL

Inspect url in Google Search Console.

Inputs

Inspection urlinspection_urltext
Page URL to inspect. Leave empty to inspect the property home page.
Site urlsite_urltextRequired
Site url.
Language codelanguage_codetext
Language code.

Outputs

Response.

dataobject
Index-Status inspection response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "inspectionResult": {
      "ampResult": {
        "ampIndexStatusVerdict": "VERDICT_UNSPECIFIED",
        "ampUrl": "Example",
        "indexingState": "AMP_INDEXING_STATE_UNSPECIFIED",
        "issues": [],
        "lastCrawlTime": "Example",
        "pageFetchState": "PAGE_FETCH_STATE_UNSPECIFIED",
        "robotsTxtState": "ROBOTS_TXT_STATE_UNSPECIFIED",
        "verdict": "VERDICT_UNSPECIFIED"
      },
      "indexStatusResult": {
        "coverageState": "Example",
        "crawledAs": "CRAWLING_USER_AGENT_UNSPECIFIED",
        "googleCanonical": "Example",
        "indexingState": "INDEXING_STATE_UNSPECIFIED",
        "lastCrawlTime": "Example",
        "pageFetchState": "PAGE_FETCH_STATE_UNSPECIFIED",
        "referringUrls": [],
        "robotsTxtState": "ROBOTS_TXT_STATE_UNSPECIFIED",
        "sitemap": [],
        "userCanonical": "Example",
        "verdict": "VERDICT_UNSPECIFIED"
      },
      "inspectionResultLink": "Example",
      "mobileUsabilityResult": {
        "issues": [],
        "verdict": "VERDICT_UNSPECIFIED"
      },
      "richResultsResult": {
        "detectedItems": [],
        "verdict": "VERDICT_UNSPECIFIED"
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

List properties

List sites in Google Search Console.

Inputs

None.

Outputs

Response.

dataobject
List of sites with access level information.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "siteEntry": []
  },
  "has_more": false,
  "next_cursor": null
}

List sitemaps

List sitemaps in Google Search Console.

Inputs

Site urlsite_urltextRequired
Site url.

Outputs

Response.

dataobject
List of sitemaps.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "sitemap": []
  },
  "has_more": false,
  "next_cursor": null
}

Query search analytics

Query search analytics in Google Search Console.

Inputs

Site urlsite_urltextRequired
Site url.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Dimensionsdimensionslist
Dimensions.One or more of: date, hour, query, page, country, device, searchAppearance.
Search typesearch_typetext
Search type.One of: web, image, video, news, discover, googleNews.
Data statedata_statetext
Data state.One of: final, all, hourly_all.
Aggregation typeaggregation_typetext
Aggregation type.One of: auto, byPage, byProperty.
Row limitrow_limitnumber
Row limit.At least 1.
Start rowstart_rownumber
Start row.At least 0.
Dimension filtersdimension_filterslist
Dimension filters.

Outputs

Response.

dataobject
A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "metadata": {
      "firstIncompleteDate": "Example",
      "firstIncompleteHour": "Example"
    },
    "responseAggregationType": "AUTO",
    "rows": []
  },
  "has_more": false,
  "next_cursor": null
}

Remove property

Remove a property from your account. This does not delete its website.

Inputs

Site urlsite_urltextRequired
Site url.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Submit sitemap

Submit sitemap in Google Search Console.

Inputs

Site urlsite_urltextRequired
Site url.
Sitemap urlsitemap_urltextRequired
Sitemap url.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page