Get links within live content

Returns every link found in the live, publicly reachable content of the platform, one entry per link, with the target as it is stored, the absolute url it resolves to, whether that url is external to the site, and the module, title, url and id of the content the link was found in. A target that is not a usable web url, such as a mailto or javascript target, is still returned but with a null url and no external indication. canonicalUrl is the url a visitor is actually served: the site rewrites legacy targets such as /Pages/News/Display.aspx?Title=a-slug to /News/a-slug, so such a target is flagged with targetIsLegacyForm and is valid rather than broken. It falls back to url when no rewrite applies. targetKind says what the target points at (InternalContent, InternalSystem, InternalOther, External, Mailto, Tel, Fragment or Unsupported) and targetStatus (Live, NotLive or Unknown) says whether it points at live content of this platform, resolved from the platform's own content and routes without the api making any request. InternalSystem is a route of the platform itself, such as the home page, a module index, the checkout or the manager, and is always Live; a route that names an entity, such as a donation, product or group, is InternalOther. targetContentId is set when the target resolves to live content. Anything that cannot be decided without requesting it, such as an external url or an internal file, is Unknown. requiresHttpCheck is true exactly for those Unknown web targets: request the canonicalUrl of the entries flagged true and treat a 4xx or 5xx response as broken, and take every other entry from targetStatus, where NotLive is broken. Results are paged by content item: use page and per_page, which defaults to 50 and allows a maximum of 500, and every link of every item on the page is returned, so a page holds a variable number of entries. Total-Resource-Count keeps its meaning and gives the total number of live content items across every page, not the number of links; a content item whose own url cannot be composed contributes no links. Page-Item-Count gives the number of links in this response, and a Link header with rel="next" is present only while a further page exists, so no trailing empty request is needed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Query Params
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