Summarize backlinks for each page of a target

Return per-page backlink summaries for a target domain or subdomain, each page with backlink, referring-domain, and spam-score counters, to find the most-linked pages.

Pricing — $$ · min $0.05

Minimum 50 credits ($0.05) per call. Records returned above the minimum bill 1 credit ($0.001) each.

Authorization

bearerAuth

AuthorizationBearer <token>

UnifAPI API key. Provider credentials are managed by UnifAPI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

target*string

Domain, subdomain, or page to analyze. A domain or subdomain is specified without https:// and www. (example.com); a page is specified as an absolute URL (https://example.com/blog/).

Length1 <= length <= 2048

backlinks_status_type?SeoBacklinksStatusType

Which backlinks to count: live (found on the last check, default), all, or lost.

Value in"live" | "all" | "lost"

include_subdomains?boolean

Include backlinks pointing to the target's subdomains. Defaults to true.

include_indirect_links?boolean

Include indirect links (via redirects or canonicals) to the target. Defaults to true.

exclude_internal_backlinks?boolean

Exclude internal backlinks from the target's own subdomains. Defaults to true.

internal_list_limit?integer

Maximum number of entries kept in each referring_links_* breakdown map. Defaults to 10.

Range1 <= value <= 1000

rank_scale?SeoBacklinksRankScale

Scale for rank values: one_thousand (0-1000, default) or one_hundred (0-100).

Value in"one_hundred" | "one_thousand"

filters?||

Filter the returned page summaries. Provide a single condition {"field","op","value"} or an {"and":[…]} / {"or":[…]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: url (page URL on the target); rank (backlink rank, 0-1000); backlinks (number of backlinks); backlinks_spam_score (average spam score, 0-100); referring_domains (referring domains count); referring_main_domains (referring root domains count); referring_pages (referring pages count); referring_ips (referring IPs count); referring_subnets (referring subnets count); broken_backlinks (backlinks to broken pages); broken_pages (broken pages still receiving backlinks); first_seen (ISO date the first backlink was found); lost_date (ISO date the last backlink was lost). Example: {"field":"referring_domains","op":">","value":5}

backlinks_filters?||

Filter the underlying individual backlinks before the aggregate metrics are computed. Provide a single condition {"field","op","value"} or an {"and":[…]} / {"or":[…]} group of conditions (nest groups for mixed logic), up to 8 conditions. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, match, not_match (use an array value with in / not_in). Filterable fields: dofollow (boolean, link is dofollow); is_new (boolean, appeared since the last check); is_lost (boolean, lost since the last check); is_broken (boolean, points to a broken page); rank (referring page rank, 0-1000); page_from_rank (referring page rank, 0-1000); domain_from_rank (referring domain rank, 0-1000); backlink_spam_score (spam score of the referring page, 0-100); item_type (anchor, image, link, redirect, or canonical); anchor (anchor text); tld_from (top-level domain of the referring page); semantic_location (link location, e.g. article, footer); first_seen (ISO date the backlink was first seen); last_seen (ISO date the backlink was last seen). Example: {"and":[{"field":"dofollow","op":"=","value":true},{"field":"backlink_spam_score","op":"<","value":10}]}

order_by?array<>

Sort the returned page summaries. Each rule is {"field","dir"} with dir asc or desc; up to 3 rules, applied in order. Sortable fields: url, rank, backlinks, backlinks_spam_score, referring_domains, referring_main_domains, referring_pages, referring_ips, referring_subnets, broken_backlinks, broken_pages, first_seen, lost_date.

Items1 <= items <= 3

limit?integer

Maximum number of records to return. Defaults to 100.

Range1 <= value <= 1000

offset?integer

Number of records to skip from the start of the results.

Range0 <= value

view?string

Value in"summary" | "full"

Response Body

`application/json`

curl -X POST "https://example.com/seo/backlinks/domain-pages-summary" \  -H "Content-Type: application/json" \  -d '{    "target": "string"  }'

{
  "request_id": "string",
  "data": {
    "target": "string",
    "view": "summary",
    "total_count": 0,
    "results": [
      {
        "url": "string",
        "rank": 0,
        "backlinks": 0,
        "backlinks_spam_score": 0,
        "first_seen": "string",
        "lost_date": "string",
        "broken_backlinks": 0,
        "broken_pages": 0,
        "referring_domains": 0,
        "referring_main_domains": 0,
        "referring_pages": 0,
        "referring_ips": 0,
        "referring_subnets": 0,
        "referring_domains_nofollow": 0,
        "referring_main_domains_nofollow": 0,
        "referring_pages_nofollow": 0,
        "referring_links_tld": {
          "property1": 0,
          "property2": 0
        },
        "referring_links_types": {
          "property1": 0,
          "property2": 0
        },
        "referring_links_attributes": {
          "property1": 0,
          "property2": 0
        },
        "referring_links_platform_types": {
          "property1": 0,
          "property2": 0
        },
        "referring_links_semantic_locations": {
          "property1": 0,
          "property2": 0
        },
        "referring_links_countries": {
          "property1": 0,
          "property2": 0
        }
      }
    ]
  },
  "billing": {
    "credits_charged": 0,
    "records_charged": 0,
    "balance_remaining": 0,
    "truncated_due_to_balance": true
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

{
  "error": {
    "type": "validation_error",
    "message": "string",
    "request_id": "string",
    "issues": [
      null
    ],
    "billing": {
      "credits_required": 0,
      "credits_charged": 0,
      "records_charged": 0,
      "balance_remaining": 0,
      "truncated_due_to_balance": true
    }
  }
}

Summarize backlinks for each page of a target

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

404application/json

429application/json

500application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`