List the backlinks known for a website.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/links

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

statusstring

live, lost, broken, unknown or pending.

sourcestring

Discovery source: gsc_csv, bing_csv, bing_api, manual, prospect, mention, crawl.

domainstring

Only links from this domain.

searchstring

Match against URL and anchor text.

followedboolean

true for followed links, false for nofollow.

disavowedboolean

true for disavowed links only.

problemsboolean

true for lost or broken links only.

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringBacklink id. Use it as link_id.

source_urlstringPage that links to the site.

source_domainstringDomain of the linking page.

target_urlstringPage on the site being linked to.

anchor_textstring | nullLink text.

is_followedboolean | nullNull until verified.

placementstring | nullcontent, nav, footer or sidebar once verified.

statusstringlive, lost, broken, unknown or pending.

discovery_sourcesarray of stringsWhere the link was learned from.

disavowedbooleanIncluded in the disavow file.

notesstring | nullFree-text notes.

first_seen_atstring | nullFirst time the link was known.

last_checked_atstring | nullLast time the page was opened to verify it.

lost_atstring | nullWhen the link stopped being found.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.listSiteLinks('<site_id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": "string",
      "source_url": "string",
      "source_domain": "string",
      "target_url": "string",
      "anchor_text": "string",
      "is_followed": true,
      "placement": "string",
      "status": "string",
      "discovery_sources": [],
      "disavowed": true,
      "notes": "string",
      "first_seen_at": "string",
      "last_checked_at": "string",
      "lost_at": "string"
    }
  ]
}