List broken link pages

GET

https://api.modulards.com/api/public/v1/site-broken-link-pages

GET

/api/public/v1/site-broken-link-pages

curl https://api.modulards.com/api/public/v1/site-broken-link-pages \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "attributes": {
        "by_category": {
          "broken_link": 2,
          "mixed_content": 1
        },
        "by_severity": {
          "error": 2,
          "info": 0,
          "warning": 1
        },
        "ignored_at": null,
        "issues_count": 3,
        "last_scanned_at": "2026-09-16T09:14:00.000000Z",
        "source_title": "Old post",
        "source_type": "post",
        "source_url": "https://example.com/blog/old-post"
      },
      "id": "501",
      "type": "site-broken-link-pages"
    },
    {
      "attributes": {
        "by_category": {
          "broken_link": 0,
          "mixed_content": 0
        },
        "by_severity": {
          "error": 0,
          "info": 0,
          "warning": 0
        },
        "ignored_at": "2026-09-17T08:00:00.000000Z",
        "issues_count": 0,
        "last_scanned_at": "2026-09-10T03:12:00.000000Z",
        "source_title": "Jane's author page",
        "source_type": "page",
        "source_url": "https://example.com/author/jane"
      },
      "id": "502",
      "type": "site-broken-link-pages"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-broken-link-pages?filter%5Bsite%5D=12345&page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-broken-link-pages?filter%5Bsite%5D=12345&page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Lists the pages of one website on which the Broken Links Checker found issues, with how many issues each has. Pages that are resolved (the crawler no longer finds them) never appear.

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. filter[category], filter[severity] and filter[location] change the per-page counters (by_category, by_severity) rather than removing pages from the list.

A muted page stays listed: ignoring it detaches every issue from it, so it appears with every counter at 0. It shows in the unfiltered list and with filter[ignored]=1; filter[ignored]=0 hides it.

Your role must be allowed to read Broken Links Checker pages; without it the request answers 404. See “Ignore or restore broken link pages” to mute or restore pages.

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[category]stringOptional

broken_link or mixed_content. Changes the per-page counters; it does not remove pages.

filter[severity]stringOptional

error, warning or info. Changes the per-page counters; it does not remove pages.

filter[location]stringOptional

internal or external. Changes the per-page counters; it does not remove pages.

filter[ignored]stringOptional

1 returns only muted pages (every counter answers 0); 0 hides muted pages. Omit it for both.

filter[issues]stringOptional

Only the pages still attached to this issue id.

filter[s]stringOptional

Free-text search over the page URL.

sortstringOptional

issues_count, source_url or last_scanned_at; prefix with - for descending. Default: -issues_count.

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 pages

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error