# Find broken and redirected links in documentation

**Use case:** 

Crawl ten pages of the Python HOWTO docs and check their links, reporting broken links plus internal links that go through a redirect (for example /bugs.html to /3/bugs.html) so you can update them. Point it at your own docs site before a release to keep links clean.

## Input

```json
{
  "urls": [
    "https://docs.python.org/3/howto/"
  ],
  "maxPages": 10,
  "maxLinksToCheck": 120,
  "checkExternalLinks": true,
  "reportRestricted": false,
  "checkImages": true,
  "checkAssets": false,
  "report": "problems+redirects",
  "useSitemap": false,
  "crawlScope": "path",
  "maxConcurrency": 10,
  "mode": "auto",
  "respectRobotsTxt": false,
  "slowThresholdMs": 5000,
  "onlyNewBroken": false,
  "httpVia": "auto",
  "pageTimeoutSecs": 120
}
```

## Output

```json
{
  "url": {
    "label": "Linked URL",
    "format": "link"
  },
  "redirectStatus": {
    "label": "Redirect status"
  },
  "finalUrl": {
    "label": "Final URL",
    "format": "link"
  },
  "redirects": {
    "label": "Redirects"
  },
  "internal": {
    "label": "Internal"
  },
  "site": {
    "label": "Site"
  },
  "foundOnPages": {
    "label": "Found on pages"
  },
  "firstFoundOn": {
    "label": "First found on",
    "format": "link"
  },
  "firstAnchorText": {
    "label": "Link text"
  }
}
```

## How it works

### 1. Sign up on Apify or log in

The Broken Link Checker - Find 404 & Dead Links on Any Website Actor is ready to run with the inputs already set for "Find broken and redirected links in documentation". [Sign up or log in](https://console.apify.com/create-task-from-example/JSrrAKeVatccM6XlL) and you'll land in Apify Console with a copy of this exact task.

### 2. Start the "Find broken and redirected links in documentation" task

The Broken Link Checker - Find 404 & Dead Links on Any Website Actor will start running based on the input automatically. You can also change all the input fields, like URLs or domains, max pages to crawl, and more, to match your specific use case.

### 3. Receive the "Find broken and redirected links in documentation" output

Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as linked url, redirect status, final url, and more.

### 4. Integrate into your workflow

The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also [run the "Find broken and redirected links in documentation" task via API](https://apify.com/tidytools/broken-link-checker.md).

## About this Actor

This example demonstrates how to use [Broken Link Checker - Find 404 & Dead Links on Any Website](https://apify.com/tidytools/broken-link-checker.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/tidytools/broken-link-checker.md) to learn more, explore other use cases, and run it yourself.


## How to integrate an Actor?

This Task's input is already configured above. Use it as-is rather than inventing a new one.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For full API examples (JavaScript, Python, CLI, MCP, OpenAPI), see this Task's Actor page: https://apify.com/tidytools/broken-link-checker.md

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).