Indexing Insight API
  1. Guides
Indexing Insight API
  • Getting Started
  • Guides
    • Authorization
    • Rate limiting
    • Response errors
    • API key details
    • URL report
    • Index coverage
  • Clients
    • Screaming Frog
    • Google Sheets
  • References
    • API key details
      GET
    • URL report
      GET
    • Index coverage
      GET
  1. Guides

Index coverage

The Index Coverage report is a list of all the page URLs being monioted by Indexing Insight for a domain.
We allow developers to view all the monitored page URLs, index summary and other valuable indexing data for each URL.

Request Index Coverage#

The index coverage report indexing data for a domain can be requested using the GET /v1/urls/, including the Domain ID, and including the API key in the Authorization header.
METHOD: GET
URL: /v1/urls/[DOMAIN_ID]
HEADERS:
Authorization: Bearer [API_KEY_GENERATED]
The Domain ID can be found in either the Indexing Insight app in any report URL or in the Account Details.
https://app.indexinginsight.com/domain/[Domain ID]/pages/[URL ID]

Filter Index Coverage#

Developers can filter the index coverage data with the following properties:
Segment
Index summary
Index Coverage State

Filter by segment#

The segment property can be used to filter the data to return a list of URLs under a specific web property.
For example if you wanted to filter on the web property https://indexinginsight.com/products/.
You need to append the ?segment= parameter to the URL endpoint:

Filter by index_summary#

The index_summary property can be used to filter the data to return a list of URLs under a specific web property.
For example if you wanted to filter on just the indexed pages.
You need to append the ?index_summary=Indexed parameter to the URL endpoint:

Filter by index_coverage_state#

The index_coverage_state property can be used to filter the data to return a list of URLs under a specific web property.
For example if you wanted to filter on just the indexed pages.
You need to append the ?index_coverage_state=URL is unknown to Google parameter to the URL endpoint:

Filter with multiple properties#

You can also filter the Index Coverage data by using & character to add multiple properties.
For example:

Index Coverage Results#

The URL Report results schema is returned by the GET /v1/urls/ endpoint.

URL#

The URL property is the URL of the page being monitored by Indexing Insight.

Index Summary#

The index_summary property is a summary if the page is indexed or not indexed in Google Search.
The results from this property are one of the following:
FieldDescription
IndexedThe page URL is indexed in Google.
Not IndexedThe page URL is not indexed in Google.
nullNo data for the page URL in Indexing Insight.

Index Coverage State#

The index_coverage_state indicates the index coverage state of the page in Googles's Search Index.
The results from this property are the same as the coverageState property in the URL Inspection API documentation.
A full list of index coverage states names and descriptions can be found here.

Canonicals Match#

The canonicals_match property is a boolean that indicates whether the Google-selected canonical URL matches the user-declared canonical URL.
The results from this property are one of the following:
FieldDescription
trueThe Google selected and use selected canonical URLs match.
falseThe Google selected and use selected canonical URLs do not match.
nullNo data for the page URL in Indexing Insight.

Google Selected Canonical#

The google_selected_canonical property is the canonical URL chosen by Google's Search Index.
The property's results are equivalent to those of the GoogleCanonical property described in the URL Inspection API documentation.

User Selected Canonical#

The user_selected_canonical declared canonical URL on the page.
The property's results are equivalent to those of the UserCanonical property described in the URL Inspection API documentation.

Last Crawl Time#

The last_crawl_time property is the last time the page was crawled by Googlebot's primary crawler.
The property's results are equivalent to those of the LastCrawlTime property described in the URL Inspection API documentation.

Days Since Last Crawl#

The days_since_last_crawl property is the number of days since Googlebot primary crawler last crawled the page.
The days_since_last_crawl property is updated every 24 hours based on the last_crawl_time property, which records when Googlebot last crawled the page.

Inspection Link#

Theinspection_link property is the link to the URL Inspection tool for the page URL in Google Search Console. This property will always be included in the response, and will be a string.

Indexing Insight Link#

Theindexing_insight_link property is the link to the URL report for the specific URL being monitored. This property will always be included in the response, and will be a string.
Modified at 2025-05-22 13:26:07
Previous
URL report
Next
Screaming Frog
Built with