Index Metadata
What's Covered?
In this guide you’ll learn more about making API calls to the Index Metadata endpoint for the Links API V2.
This documentation specifies information for Moz Links API V2. V1 documentation is available here.
What is this endpoint for?
Use this endpoint to track when the index is updated with new data. When queried, the endpoint returns an ID that changes when the data in the index changes. This information can be helpful when you’re looking to understand the freshness of the data. It can also help benchmark when new links are discovered - particularly if you’re tracking a link building Campaign and want to keep an eye out for index updates that may include new links.
Quick Links
Getting Started
Before making calls to the Index Metadata endpoint, be sure you are set up with an Access ID and Secret Key within your Moz Account.
Just a reminder - the Links API V2 supports Basic Auth in which you are able to use your Access ID as a username and and your Secret Key as a password.
All requests and responses are structured in JSON.
Endpoint Location
When requesting index metadata from Links V2, be sure to use the following endpoint.
https://lsapi.seomoz.com/v2/index_metadata
Request Syntax
{}
Example JSON Request
{}
Request Parameters
None
Response Syntax
{
"index_id": "string"
}
Example JSON Response
{
"index_id": "p/z6qTYXg9J/Zp0W7Ei1FA==",
"spam_score_update_days": [
"2019-02-08",
"2020-03-28",
"2020-08-03",
"2020-11-13",
"2021-02-24"
]
}
Response Elements
“index_id” - An opaque id that changes when data in the index is updated.
- Type: string
Errors
See the Common Errors section for errors that are common to all endpoints.
Example HTTP Request
POST /v2/index_metadata
Host: lsapi.seomoz.com
Content-Length: [length of request payload in bytes]
User-Agent: [user agent string]
Authorization: Basic [credentials]
{}
Example cURL Request
curl -d '{}' -X POST https://lsapi.seomoz.com/v2/index_metadata -u 'access_id:secret_key'
Example Python Request
import requests
auth = (access_id, secret_key)
url = "https://lsapi.seomoz.com/v2/index_metadata"
data = "{}"
request = requests.post(url, data=data, auth=auth)
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.