About this endpoint
What it does
Checks all links found on a webpage identified by its URL and returns a JSON object with link-check results, a summary, and metadata about the scan.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | HTTP/HTTPS URL of the page whose links should be checked. Format: URI. |
Response
Returns a JSON object with a data object field. data contains three top-level objects: summary (object), details (array), and meta (object).
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Wrapper object containing summary, details, and meta. |
| data.summary | Object | Yes | Summary counts for the scan. Fields: totalLinks (integer), ok (integer), broken (integer), redirects (integer), slowLinks (integer), errors (integer). |
| data.details | Object Array | Yes | Array of per-link result objects. Each item may include url (string), slow (boolean), type (string enum: internal, external), error (string or null), status (string enum: ok, redirect, broken, error, timeout, dns_error, blocked, restricted, invalid_url, ignored), finalUrl (string or null), statusCode (integer or null), responseTime (integer or null, in milliseconds), and redirectChain (string array). |
| data.meta | Object | Yes | Metadata about the scan. Fields: sourceUrl (string), linksChecked (integer), limitApplied (boolean). limitApplied is true when the page had more than 200 links and the list was capped. |
Notes
If the page contains more than 200 links, the returned list is capped and data.meta.limitApplied is true.