README.md

Google Index Inspection API

Extract indexing status from the newest Google Search Console API endpoint. If you want a more in-depth explanation you can read my blog post here.

How to run the script

Install the necessary packages

npm install

Update the urls.csv file with the individual URLs that you would like to check in the first column and the GSC property which they belong to. Keep the headers.

url,property
https://jlhernando.com/blog/how-to-install-node-for-seo/,https://jlhernando.com/
https://jlhernando.com/blog/index-coverage-extractor/,https://jlhernando.com/

Update the credentials-secret.json using your own OAuth 2.0 Client IDs credentials from your Google Cloud Platform account.

Run the script from your terminal

npm start

Progress messages

If the script is able to authenticate you from the URLs and properties you are trying to check you will see a series of progress messages:

On the contrary if either your credentials don't match the set of URLs and properties you are trying to extract, you will receive a failed message and the script will stop.

Expected output

If the script has been successful in retrieving index status data, you will have a credentials.csv file and a credentials.json file under the RESULTS folder (unless you have changed the name in the script).

If there are any extractions errors, these will be in another file named errors.json