Internal Linking

List internal link suggestions

Changed on

The internal links the analysis suggests adding, best first. Each has the page to add the link on (sourceUrl), the page it should point to (targetUrl), the exact words on the source page to turn into the link (anchorText) with the sentence around them, a confidence from 0 to 1, why it was suggested, and its status: pending, approved, rejected or applied. counts gives the total in each status for the brand. Filter by status, by one page, by a folder or by topic group. Use this to answer 'what internal links should I add' or 'which pages should link to X'. Read-only.

get/v3/site-linking/suggestions

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/site-linking/suggestions
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

teamIdstring required

SnowSEO team ID. Call list_teams first to choose a team.

status'pending' | 'approved' | 'rejected' | 'applied'

Only suggestions in this status.

minConfidencenumber

Only suggestions at or above this confidence.

searchstring

Text to find in either page address or the link text.

clusterIdsstring

Comma-separated topic group ids from internal_link_analysis. Only suggestions whose source page is in one of them.

pageUrlstring

Only suggestions that start or end at this page address.

sourcePrefixstring

Only suggestions whose source page address starts with this, e.g. 'https://example.com/blog'.

sortBy'source' | 'linkText' | 'target' | 'why' | 'confidence' | 'status'

What to order by: the source page, the link text, the target page, the reason, the confidence or the status. Default confidence.

sortDir'asc' | 'desc'

Default desc, so the best come first.

pageinteger

1-based page. Default 1.

pageSizestring

Rows per page (max 1000), or 'all'. Every response reports total and totalPages.

Response

Default Response

Changes