Skip to main content
POST
Return live backlinks for a domain, subdomain, or page

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional key for safely retrying a billable write request.

Required string length: 1 - 255

Body

application/json
target
string
required
Available options:
all,
live,
lost
custom_mode
object
filters
array
include_subdomains
boolean
limit
integer
Required range: 1 <= x <= 1000
mode
enum<string>
Available options:
as_is,
one_per_domain,
one_per_anchor
offset
integer
Required range: 0 <= x <= 20000
order_by
string[]
Maximum array length: 3
rank_scale
enum<string>
Available options:
one_hundred,
one_thousand
search_after_token
string
tag
string
Maximum string length: 255

Response

Backlink records.

items
object[]
required
items_count
integer
required
next_cursor
string | null
required
target
string
required
total_count
integer
required