Skip to navigation

List broken link issues

View as MarkdownOpen in Claude

Lists the broken links and mixed-content resources found on one website. Only issues that are still open are returned: resolved ones (the crawler no longer finds them) are excluded whatever the filters.

filter[site] is required, so the list is always for one website; a website out of your reach answers 404, and an id that is not a website answers 422. Each issue tells you the target_url, its category (broken_link or mixed_content), its severity (error, warning or info), the HTTP status the link answered (null when it never answered), how many pages of the website still link to it (pages_count) and, when muted, ignored_at.

Your role must be allowed to read Broken Links Checker issues; without it the request answers 404. See “Summarize broken link issues” for the aggregated counts and “Ignore or restore broken link issues” to mute or restore issues.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[site]stringOptional

Required. Exact website id: the list is always for one website.

filter[status_code][]stringOptional
HTTP status codes, for example 404 or 500. Repeat the parameter for several. A link that never answered has no code and matches no value.
filter[category][]stringOptional

broken_link or mixed_content. Repeat the parameter for several.

filter[severity][]stringOptional

error, warning or info. Repeat the parameter for several.

filter[ignored]stringOptional

1 returns only muted issues; 0 only the ones still counting. Omit it for both.

filter[location]stringOptional

internal or external.

filter[s]stringOptional

Free-text search over the target URL.

filter[pages]stringOptional
Only the issues still attached to this page id.
sortstringOptional

created_at, last_checked_at, status_code or severity; prefix with - for descending. Default: -created_at. severity follows the real order (info, warning, error), not the alphabet: -severity lists errors first.

page[number]stringOptional
Page number, starting at 1. Default 1.
page[size]stringOptional
Items per page, 1 to 50. Default 15.

Response

200 - Broken Links issues

datalist of objectsOptional
jsonapiobjectOptional
metaobjectOptional

Errors

422
Unprocessable Entity Error