Get the distinct link targets within live content

Returns every distinct link target of the platform once, however many content items hold it, so a shared navigation or footer link is reported a single time rather than once per content item. Each entry carries the same target fields as GET /content/links plus occurrences, the number of entries of that endpoint holding the target, which is one per live content item it occurs in because a target repeated within a single content item is reported once, and content, the live content it occurs in. canonicalUrl is the url a visitor is served, and a target flagged with targetIsLegacyForm is a form the site rewrites, so it is valid rather than broken. targetStatus resolves internal targets against the live content and routes of this platform without the api making any request. Request the canonicalUrl of the targets flagged with requiresHttpCheck and treat a 4xx or 5xx response as broken; every other target is taken from targetStatus, where NotLive is broken. De-duplication is across the whole platform rather than the page, so the targets are aggregated before they are paged and a target appears on exactly one page. A document relative target such as about-us resolves against the url of the content holding it, so a target that resolves to more than one url is reported once per url. Results are ordered by target and then by url: use page and per_page, which defaults to 200 and allows a maximum of 500. Every request aggregates the whole platform before it pages, so a large page is cheaper to walk than a small one. Total-Resource-Count gives the number of distinct targets across every page, Page-Item-Count the number in this response, and a Link header with rel="next" is present only while a further page exists. Use GET /content/links to find every content item a target must be fixed in.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
int32

A cursor used for pagination and defines the page number.

int32

A cursor used for pagination and defines the number of distinct targets to retrieve per page. Defaults to 200, the maximum is 500.

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json