SEO

List backlinks

Pages linking to the site, live and lost, with anchor text, the linking page's authority and when each was first seen — and the live, lost and referring-domain totals.

GEThttps://api.vidrys.com/v1/projects/{project_id}/seo/backlinks
Plan
Track and above
Key
read
Rate cost
1 unit

The profile is refreshed weekly from a backlink index. lost means a sweep stopped seeing a link, which can lag the web by days; on a profile too large to read in full, links are added but never marked lost.

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Path parameters

project_idstringrequired

The project's id, from List projects.

Query parameters

statusenum<string>

Only live or only lost links. Omit for both.

Values:livelost

pageintegerdefault 1

Page number, from 1.

page_sizeintegerdefault 50

Rows per page, 1–100.

Response · 200

application/json

liveinteger

Links seen on the latest sweep.

lostinteger

Links a sweep stopped seeing.

referring_domainsinteger

Distinct domains among the live links.

backlinksobject[]

The rows, newest first.

+Show child attributes
idstring

Backlink id.

source_urlstring

The page that links to the site.

source_domainstringnullable

That page's domain.

target_urlstring

The page it links to.

anchorstringnullable

The link's text.

authoritynumbernullable

The linking page's rank in the backlink index, 0–1000.

nofollowboolean

Whether the link carries rel=nofollow.

first_seenstringnullable

When Vidrys first recorded it. Day, as YYYY-MM-DD.

lost_atstringnullable

When a sweep stopped seeing it; null while live. Day, as YYYY-MM-DD.

pageobject

Where these rows sit in the full list.

+Show child attributes
pageinteger

This page's number, from 1.

page_sizeinteger

Rows per page.

totalinteger

Rows across every page.

Errors

403 plan_feature_unavailableThe feature is on a higher plan. Bulk exports and webhooks are Custom-only.
404 not_foundThe project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
422 invalid_requestA parameter or body field is missing or has the wrong type or value. The message names the field. Also returned when a write would pass the plan's prompt limit.
401 unauthorizedNo key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated.
402 plan_requiredThe workspace's plan doesn't include API access. It's included on every plan from Track up — Solo is the one without it.
403 workspace_not_approvedThe workspace is still waiting for approval, or wasn't approved.
429 rate_limitedToo many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry.

Every code, and what to retry, is in Errors.