Refresh Seo Tracked Domain

POST

/seo/domains/tracked/{domain}/refresh

• Production
• QA

SPENDS CREDITS. Refresh a saved domain’s snapshot: overview, backlinks and a keyword sample.

At most refresh_credits (see GET /seo/domains/tracked); that maximum is held before any provider call, so a balance that cannot cover it is a 402 naming the amount. A retry within minutes of a successful refresh returns the saved snapshot for free (refreshed is false). A provider outage is a 502 that says so.

Authorizations

• BearerAuth

Parameters

Path Parameters

domain

required

A saved domain from GET /seo/domains/tracked.

string

A saved domain from GET /seo/domains/tracked.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

Mirrors TrackedDomainDetailResponse: one domain’s saved snapshot, rendered without any paid call. Empty until the first refresh in the app.

object

backlinks

Any of:

SeoBacklinksOverview

Mirrors BacklinksOverviewResponse.

object

authority_score

Any of:

number

number

null

null

dofollow

Any of:

integer

integer

null

null

nofollow

Any of:

integer

integer

null

null

referring_domains

Any of:

integer

integer

null

null

total_backlinks

Any of:

integer

integer

null

null

null

null

change_30d

Any of:

SeoDomainChange

Mirrors DomainChangeDTO: the current snapshot against the one nearest 30 days back. traffic_pct is null when the baseline traffic was zero.

object

keywords_delta

Any of:

integer

integer

null

null

since

Any of:

string

string

null

null

traffic_pct

Any of:

number

number

null

null

null

null

data_freshness

string

default: labs-30-90d

domain

required

string

is_primary

boolean

kind

required

string

Allowed values: own competitor

metrics

Any of:

SeoTrackedDomainMetrics

Mirrors TrackedDomainMetricsDTO.

object

authority_score

Any of:

number

number

null

null

estimated_traffic

Any of:

number

number

null

null

organic_keywords

Any of:

integer

integer

null

null

referring_domains

Any of:

number

number

null

null

top3_positions

Any of:

integer

integer

null

null

traffic_basis

Any of:

string

string

null

null

null

null

name

Any of:

string

string

null

null

overview

Any of:

object

object

key

additional properties

any

null

null

refreshed

boolean

snapshot_at

Any of:

string

string format: date-time

null

null

top_keywords

Array<object>

default:

object

key

additional properties

any

top_pages

Array<object>

default:

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string