Competitor backlink gap and comparison history
Competitor backlink gap and comparison history. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.
/projects/{project_uid}/backlinks/gapRequires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.
Authorization
bearerApiKey Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.
In: header
Path Parameters
Accessible project UID. Discover it with GET /projects; do not guess it.
^[a-z0-9]{10}$Query Parameters
Maximum records to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned by the prior response. Do not construct or alter it.
length <= 512Added competitor ID from backlink options; required for gap.
1 <= valueUse the dataset's supported sorting columns from backlink options.
Value in
- "backlinks"
- "spam_score"
Sort direction.
"desc"Value in
- "asc"
- "desc"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/projects/string/backlinks/gap?competitor_id=1"{ "data": [ { "id": "string", "position": 0, "domain_from": "string", "url_from": "string", "url_to": "string", "anchor": "string", "rank": 0, "page_rank": 0, "domain_rank": 0, "spam_score": 0, "dofollow": true, "is_new": true, "is_lost": true, "is_broken": true, "first_seen": "string", "last_seen": "string", "status_code": 0, "semantic_location": "string" } ], "links": { "next": "string" }, "meta": { "limit": 0, "next_cursor": "string", "total": 0, "target": "string", "summary": { "property1": 0, "property2": 0 }, "history": [ { "date": "2019-08-24", "own": 0, "competitor": 0 } ] }}{ "message": "Unauthenticated."}{ "message": "string", "code": "string"}{ "message": "Project not found or not accessible."}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }}{ "message": "string", "code": "string"}{ "message": "string", "code": "string"}List backlinks from one full source domain
List backlinks from one full source domain. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.
List domains with lost project backlinks
List domains with lost project backlinks. Requires backlink access on the project's billing account. Targets must be the project domain or an added competitor; lost/broken analyses use the project. Empty successful results are distinct from temporary data failures. Missing optional metrics remain null. Unsupported fields are rejected.