Broken links
GET /api/v1/crawl/{jobId}/broken-links
Every internal link that points to a 4xx/5xx page — and WHICH page contains the broken link, so you can fix it.
Path & query
| Name | Type | Description |
|---|---|---|
jobId required | string | The crawl job id returned by Start a crawl (POST /api/v1/crawl). Path parameter. |
Request
Response
200 · application/json
- {
- "jobId": "crw_7Hk29fQ",
- "startUrl": "https://example.com",
- "host": "example.com",
- "status": "done",
- "maxPages": 50,
- "createdAt": "2026-06-02T13:24:49.414Z",
- "finishedAt": "2026-06-02T13:24:52.055Z",
- "brokenCount": 1,
- "items": [
- { "fromPage": "https://example.com/blog", "brokenUrl": "https://example.com/missing", "anchor": "see this", "statusCode": 404 }
- ]
- }
Response fields
| Field | Type | Description |
|---|---|---|
brokenCount | number | Number of broken internal links found. |
items[].fromPage | string | The page containing the broken link. |
items[].brokenUrl | string | The dead target the link points to. |
items[].anchor | string | The link text (anchor) used. |
items[].statusCode | number | HTTP status returned by the broken target (4xx/5xx). |
See Errors for status codes.