LinksWatcher

LinksWatcher API endpoints

• POST/api/scanurl

  Submit URLs for scanning

  Submit a list of URLs to be scanned. Returns a `batchId` immediately — scanning happens asynchronously. **Workflow:** 1. POST this endpoint with your URLs → receive `batchId` 2. Poll `GET /api/batch/{id}` every few seconds until `status === "COMPLETED"` 3. Or configure a webhook to receive push notifications **Batch size** is capped by your plan (5–100 URLs per request). Split large lists into multiple requests. If you want batch results to include page screenshots, poll `GET /api/batch/{id}?includeScreenshot=true`. **Domains** must be in your plan's allowed domain list. Requests containing disallowed domains will be rejected with `403`.

• GET/api/batch/{id}

  Get batch status and results

  Poll this endpoint to check the progress of a batch and retrieve completed results. **Polling strategy:** We recommend polling every **2–5 seconds**. The batch reaches a terminal state (`COMPLETED` or `FAILED`) once `finishedJobs === expectedJobs`. Set `includeScreenshot=true` if you also want each completed job to include `result.screenshotBase64`. **Tip:** Instead of polling, configure a **webhook** on the batch to receive a push notification when it finishes.