Monday, January 31, 2022

At this time we’re launching the brand new Google Search Console URL Inspection API,
which provides programmatic entry to URL-level information for properties you handle in Search Console.

The Search Console APIs are a solution to entry information exterior of Search Console, by way of exterior functions and merchandise.
Builders and website positioning instruments already use the APIs to construct customized options to view, add, or take away properties and sitemaps, and to run superior queries on Search efficiency information.

With the brand new URL Inspection API, we’re offering a brand new software for builders to debug and optimize their pages. You’ll be able to request the information Search Console has concerning the listed model of a URL;
the API will return the listed data presently accessible within the URL Inspection software.

Utilizing the brand new API

As a way to learn to use the brand new API, verify the API developer documentation.
The request parameters embody the URL you’d like to examine and the URL of the property as outlined in Search Console.

The response contains evaluation outcomes containing data from Search Console, together with index standing, AMP, wealthy outcomes, and cell usability. For extra particulars, learn the
record of parameters and the
Listed URL outcomes clarification.

When you make the API name, you’ll get a response with all related outcomes, or an error message if the request fails. If a selected evaluation result’s lacking from the response,
it means the evaluation was not accessible for the URL inspected. Here is an instance of the response you’ll get from the API.

  {
  "inspectionResult": {
    "inspectionResultLink": "https://search.google.com/search-console/examine?resource_id=https://builders.google.com/search/&id=odaUL5Dqq3q8n0EicQzawg&utm_medium=hyperlink&utm_source=api",
    "indexStatusResult": {
      "verdict": "PASS",
      "coverageState": "Listed, not submitted in sitemap",
      "robotsTxtState": "ALLOWED",
      "indexingState": "INDEXING_ALLOWED",
      "lastCrawlTime": "2022-01-31T08:39:51Z",
      "pageFetchState": "SUCCESSFUL",
      "googleCanonical": "https://builders.google.com/search/assist/site-appearance-faq",
      "userCanonical": "https://builders.google.com/search/assist/site-appearance-faq",
      "referringUrls": [
        "https://developers.google.com/search/updates",
        "https://developers.google.com/search/help/crawling-index-faq"
      ],
      "crawledAs": "MOBILE"
    },
    "mobileUsabilityResult": {
      "verdict": "PASS"
    },
    "richResultsResult": {
      "verdict": "PASS",
      "detectedItems": [
        {
          "richResultType": "Breadcrumbs",
          "items": [
            {
              "name": "Unnamed item"
            }
          ]
        },
        {
          "richResultType": "FAQ",
          "objects": [
            {
              "name": "Unnamed item"
            }
          ]
        }
      ]
    }
  }
}

Potential use circumstances

Whereas constructing the brand new API, we consulted varied SEOs and publishers as regards to how they might use the API to create options with this information. Listed below are a few of the use circumstances that stand out:

• website positioning instruments and businesses can present ongoing monitoring for necessary pages and single web page debugging choices. For instance, checking if there are variations between user-declared
  and Google-selected canonicals, or debugging structured information points from a bunch of pages.
• CMS and plugin builders can add web page or template-level insights and ongoing checks for present pages. For instance, monitoring modifications over time for key pages
  to diagnose points and assist prioritize fixes.

Utilization limits

You’ll find a extra detailed description of Search Console APIs utilization limits
within the developer documentation. Particularly as regards to the URL Inspection API, the quota is enforced per Search Console
web site property (calls querying the identical website):

• 2,000 queries per day
• 600 queries per minute

Suggestions

We consider the brand new API will deliver new alternatives to the ecosystem to innovate with Google Search information; we’re at all times excited to see the options builders and SEOs construct across the
Search Console APIs.

When you’ve got any questions or suggestions, attain out to us on Twitter, or put up a query within the
Search Central group.

Posted by Daniel Waisberg and Dori Rosenberg, Search Console workforce