Moz API for Sheets
Frequently Asked Questions
Overview
The best way to pull Moz Link data in bulk is via the Links API. Typically, a developer is needed in order to write the code necessary to make calls to the API and to format the raw data for usability. With the Google Sheets add-on for the Moz Links API, you can pull data from the API without needing to write a single line of code.
The Google Sheets add-on for the Moz Links API is an independent tool developed by the community which allows users with Links API access to pull limited data in bulk without having to write code. The metrics able to be pulled with this tool include:
- Domain Authority
- Page Authority
- Spam Score*
- Subdomain External Links*
- Root Domain External Links*
- External Equity Links*
- All Links*
- Root Domains Linking*
*Metrics which require paid API access
**Please note: Because the Moz API for Sheets add-on is a free tool developed outside of Moz, Moz's ability to provide support for this add-on is limited.
Getting Started
To get started with the Google Sheets add-on for the Moz Links API you can do one of the following:
- Head to a new Google Sheets document > Add-ons > Get Add-ons > Moz API for Sheets
- Head to the GSuite Marketplace directly
This process will only need to be done once unless the add-on is uninstalled at a later date.
Once you’ve installed the Google Sheets add-on, you’re ready to get started! From the Add-ons menu at the top of the screen, select Moz API for Sheets > Start Moz Add-on
![Add-ons menu location in Google Sheets. From this menu, select Moz API for Sheets and then Start Moz Add-on.](https://moz.com/images/help/large/Links-API-GSheets-Start-Addon.png?w=879&h=349&auto=compress%2Cformat&fit=crop&dm=1593465382&s=689533fe6711169967a484a56e351e96)
After launching the Moz API for Sheets add-on, enter your API credentials in the Keys tab to start making calls. If you do not currently have Moz API access, you can sign up from our API product page.
![After launching the Moz API for Sheets add-on, enter your Moz API credentials to get started.](https://moz.com/images/help/large/Links-API-GSheets-enter-credentials.png?w=528&h=695&auto=compress%2Cformat&fit=crop&dm=1593465447&s=e87c1c8e5be8b10689cf8fa1688e4d9a)
If there is a problem with the Moz Access ID and/or Moz Secret Key, the tool will produce an Invalid Credentials error- please double check the credentials entered and that your API access is active. Please note: When signing up for a new API key, it may take up to 24 hours for the add-on to recognize your credentials as valid.
![If the credentials entered are incorrect or invalid, the add-on will return an error alerting you that the credentials are invalid.](https://moz.com/images/help/large/Links-API-GSheets-invalid-credentials.png?w=308&h=701&auto=compress%2Cformat&fit=crop&dm=1593465437&s=109f7b6c35ebeadb8df2a31204e3354c)
Making Requests
After entering your API credentials and clicking Check Access Level, you will be asked to choose the URL Level Metrics you’d like to pull via the API.
Toggle the buttons to the right of each metric to select it - when the toggle button is blue, the metric will be requested via the API when the call is made.
![Use the toggles on the right to select the metrics you'd like to pull data for and then click the button below to enter target URLs.](https://moz.com/images/help/large/Links-API-select-URL-metrics-paid.png?w=524&h=696&auto=compress%2Cformat&fit=crop&dm=1593465604&s=bdc33a15992e8aa7d1a7b39521b897a7)
If you have a free API account, you will only have the option to select Domain Authority or Page Authority.
![With free API access you will only have the option to toggle Domain Authority and Page Authority. All other metrics will be greyed out.](https://moz.com/images/help/large/Links-API-select-URL-metrics-free.png?w=508&h=697&auto=compress%2Cformat&fit=crop&dm=1593465687&s=350dd97fc0416b6efa6d687470274ca9)
When you’ve selected all the metrics you’d like included in your report, click Click to Enter URLs. You will then be prompted to enter in all the target URLs you’re wanting to request data for. Please be sure to follow the below guidelines to ensure the tool accepts the URLs entered.
- Include the full protocol for the URL (http or https) - only full URLs will be accepted
- Separate each URL by line, not by comma
- Be aware of your max URL limit based on Paid vs Free access (Any URLs over the limit will be ignored by the tool)
![A popup will open allowing you to enter the URLs you'd like to pull metrics for. Be sure to enter them separated by lines.](https://moz.com/images/help/large/Links-API-enter-URLs.png?w=1237&h=761&auto=compress%2Cformat&fit=crop&dm=1593465846&s=0ab21986305a805597a175586e14b964)
When you’re ready to gather the requested data, click Get Data. A popup will appear letting you know that the data is being gathered. Depending on the number of target URLs entered, it may take some time for the data to populate in order to adhere to call rate limits.
The data will then be populated in the Google Sheet for you to sort, filter, and analyze as needed.
Data Returned
After clicking Get Data within the add-on, the following data will be returned for each URL entered.
Information returned for every call:
- Original URL - The original target URL entered.
- Page Title - The title tag associated with the original URL.
- Canonical URL - The canonical form of the URL. Please note: this is not the actual canonical URL of the page.
- HTTP Status Code - The status code returned to the crawl when accessing the original URL.
- Date Last Crawled - The date dotbot last crawled this page.
Information returned based on metric selection for the specific call:
- External Equity Links (Paid access required) - i.e. External Followed Links. Links to the target URL from other sites that are followed (they do not have a "nofollow" tag added to the link).
- Subdomain External Links (Paid access required) - The number of domains with at least one followed link to any page on the subdomain.
- Root Domain External Links (Paid access required) - The number of domains with at least one followed link to any page on the root domain.
- Root Domains Linking (Paid access required) - Number of unique root domains linking to a target. Two links from the same website will only be counted as one linking root domain.
- Links (Paid access required) - The total number of internal, external, follow and nofollow links.
- Spam Score (Paid access required) - Spam Score represents the percentage of sites with similar features we've found to be penalized or banned by Google. This does not mean that the site is spammy. It’s best to use this is a guide to potentially spammy sites for further investigation.
- Page Authority - Page Authority is a Moz proprietary metric from 0-100 which predicts how well a page will rank in Google based on a machine learning algorithm of link metrics.
- Domain Authority - Domain Authority is a Moz proprietary metric from 0-100 which predicts how well a domain will rank in Google based on a machine learning algorithm of link metrics.
Related Articles
Was this article helpful?
Yes! Amazing!
Yes! It was what I needed.
Meh. It wasn’t really what I was looking for.
No, it wasn’t helpful at all.
Thanks for the feedback.