Welcoming the new Search Console URL Inspection API
Stay organized with collections
Save and categorize content based on your preferences.
Monday, January 31, 2022
Today we’re launching the new Google Search Console URL Inspection API,
which gives programmatic access to URL-level data for properties you manage in Search Console.
The Search Console APIs are a way to access data outside of Search Console, through external applications and products.
Developers and SEO tools already use the APIs to build custom solutions to view, add, or remove properties and sitemaps, and to run advanced queries on Search performance data.
With the new URL Inspection API, we're providing a new tool for developers to debug and optimize their pages. You can request the data Search Console has about the indexed version of a URL;
the API will return the indexed information currently available in the URL Inspection tool.
Using the new API
In order to learn how to use the new API, check the API developer documentation.
The request parameters include the URL you’d like to inspect and the URL of the property as defined in Search Console.
The response includes analysis results containing information from Search Console, including index status, AMP, rich results, and mobile usability. For more details, read the
list of parameters and the
Indexed URL results explanation.
Once you make the API call, you will get a response with all relevant results, or an error message if the request fails. If a specific analysis result is missing from the response,
it means the analysis was not available for the URL inspected. Here's an example of the response you’ll get from the API.
While building the new API, we consulted various SEOs and publishers with regards to how they would use the API to create solutions with this data. Here are some of the use cases that stand out:
SEO tools and agencies can provide ongoing monitoring for important pages and single page debugging options. For example, checking if there are differences between user-declared
and Google-selected canonicals, or debugging structured data issues from a group of pages.
CMS and plugin developers can add page or template-level insights and ongoing checks for existing pages. For example, monitoring changes over time for key pages
to diagnose issues and help prioritize fixes.
Usage limits
You can find a more detailed description of Search Console APIs usage limits
in the developer documentation. Specifically with regards to the URL Inspection API, the quota is enforced per Search Console
website property (calls querying the same site):
2,000 queries per day
600 queries per minute
Feedback
We believe the new API will bring new opportunities to the ecosystem to innovate with Google Search data; we’re always excited to see the solutions developers and SEOs build around the
Search Console APIs.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eGoogle Search Console launches a new URL Inspection API, offering programmatic access to URL-level data for properties managed within Search Console.\u003c/p\u003e\n"],["\u003cp\u003eThis API enables developers and SEO tools to debug and optimize pages by retrieving indexed information, such as index status, AMP, rich results, and mobile usability.\u003c/p\u003e\n"],["\u003cp\u003ePotential use cases include ongoing monitoring, single-page debugging, and integration into CMS or plugins for enhanced page insights.\u003c/p\u003e\n"],["\u003cp\u003eUsage is limited to 2,000 queries per day and 600 queries per minute per website property.\u003c/p\u003e\n"],["\u003cp\u003eGoogle encourages feedback and welcomes innovative solutions built using the Search Console APIs.\u003c/p\u003e\n"]]],["Google launched the URL Inspection API, enabling programmatic access to URL-level data from Search Console. Developers can use it to request indexed information about a specific URL, including its index status, AMP, rich results, and mobile usability. The API returns analysis results or error messages. The data can be used by SEO tools, agencies, CMS and plugins to monitor pages, debug issues, and compare canonical URLs. The API has a limit of 2,000 daily and 600 per minute queries per website property.\n"],null,["# Welcoming the new Search Console URL Inspection API\n\nMonday, January 31, 2022\n\n\nToday we're launching the new Google Search Console [URL Inspection API](/webmaster-tools/v1/urlInspection.index/inspect),\nwhich gives programmatic access to URL-level data for properties you manage in Search Console.\n\n\nThe [Search Console APIs](/webmaster-tools) are a way to access data outside of Search Console, through external applications and products.\nDevelopers and SEO tools already use the APIs to build custom solutions to view, add, or remove properties and sitemaps, and to run advanced queries on Search performance data.\n\n\nWith the new URL Inspection API, we're providing a new tool for developers to debug and optimize their pages. You can request the data Search Console has about the indexed version of a URL;\nthe API will return the indexed information currently available in the [URL Inspection tool](https://support.google.com/webmasters/answer/9012289).\n\nUsing the new API\n-----------------\n\n\nIn order to learn how to use the new API, check the [API developer documentation](/webmaster-tools/v1/urlInspection.index/inspect).\nThe request parameters include the URL you'd like to inspect and the URL of the property as defined in Search Console.\n\n\nThe response includes analysis results containing information from Search Console, including index status, AMP, rich results, and mobile usability. For more details, read the\n[list of parameters](/webmaster-tools/v1/urlInspection.index/UrlInspectionResult) and the\n[Indexed URL results explanation](https://support.google.com/webmasters/answer/9012289#indexed_inspection).\n\n\nOnce you make the API call, you will get a response with all relevant results, or an error message if the request fails. If a specific analysis result is missing from the response,\nit means the analysis was not available for the URL inspected. Here's an example of the response you'll get from the API. \n\n```scdoc\n {\n \"inspectionResult\": {\n \"inspectionResultLink\": \"https://search.google.com/search-console/inspect?resource_id=https://developers.google.com/search/&id=odaUL5Dqq3q8n0EicQzawg&utm_medium=link\",\n \"indexStatusResult\": {\n \"verdict\": \"PASS\",\n \"coverageState\": \"Indexed, not submitted in sitemap\",\n \"robotsTxtState\": \"ALLOWED\",\n \"indexingState\": \"INDEXING_ALLOWED\",\n \"lastCrawlTime\": \"2022-01-31T08:39:51Z\",\n \"pageFetchState\": \"SUCCESSFUL\",\n \"googleCanonical\": \"https://developers.google.com/search/help/site-appearance-faq\",\n \"userCanonical\": \"https://developers.google.com/search/help/site-appearance-faq\",\n \"referringUrls\": [\n \"https://developers.google.com/search/updates\",\n \"https://developers.google.com/search/help/crawling-index-faq\"\n ],\n \"crawledAs\": \"MOBILE\"\n },\n \"mobileUsabilityResult\": {\n \"verdict\": \"PASS\"\n },\n \"richResultsResult\": {\n \"verdict\": \"PASS\",\n \"detectedItems\": [\n {\n \"richResultType\": \"Breadcrumbs\",\n \"items\": [\n {\n \"name\": \"Unnamed item\"\n }\n ]\n },\n {\n \"richResultType\": \"FAQ\",\n \"items\": [\n {\n \"name\": \"Unnamed item\"\n }\n ]\n }\n ]\n }\n }\n}\n```\n\nPotential use cases\n-------------------\n\n\nWhile building the new API, we consulted various SEOs and publishers with regards to how they would use the API to create solutions with this data. Here are some of the use cases that stand out:\n\n- *SEO tools and agencies* can provide ongoing monitoring for important pages and single page debugging options. For example, checking if there are differences between user-declared and Google-selected canonicals, or debugging structured data issues from a group of pages.\n- *CMS and plugin developers* can add page or template-level insights and ongoing checks for existing pages. For example, monitoring changes over time for key pages to diagnose issues and help prioritize fixes.\n\nUsage limits\n------------\n\n\nYou can find a more detailed description of Search Console [APIs usage limits](/webmaster-tools/limits)\nin the developer documentation. Specifically with regards to the URL Inspection API, the quota is enforced per Search Console\n[website property](https://support.google.com/webmasters/answer/34592) (calls querying the same site):\n\n- 2,000 queries per day\n- 600 queries per minute\n\nFeedback\n--------\n\n\nWe believe the new API will bring new opportunities to the ecosystem to innovate with Google Search data; we're always excited to see the solutions developers and SEOs build around the\nSearch Console APIs.\n\n\nIf you have any questions or feedback, reach out to us [on Twitter](https://twitter.com/googlesearchc), or post a question in the\n[Search Central community](https://support.google.com/webmasters/threads?thread_filter=(category:search_console)).\nPosted by [Daniel Waisberg](https://www.danielwaisberg.com) and Dori Rosenberg, Search Console team"]]
