DocsAPI ReferenceDiff two crawls
GET/v1/diff

Diff two crawls

Compares the crawl snapshots from two different job runs using SHA-256 content hashes. Returns which pages were added, removed, changed, or unchanged between the two crawls. Useful for change monitoring.

Query parameters

NameTypeRequiredDescription
jobIdAstringrequiredEarlier crawl job ID
jobIdBstringrequiredLater crawl job ID

Example

bash
curl "http://localhost:3000/v1/diff?jobIdA=aaa...&jobIdB=bbb..."

Response

bash
{
  "success": true,
  "data": {
    "summary": { "added": 3, "removed": 1, "changed": 7, "unchanged": 76 },
    "added": [{ "url": "https://example.com/new-page" }],
    "removed": [{ "url": "https://example.com/deleted" }],
    "changed": [{ "url": "https://example.com/about", "hashA": "abc...", "hashB": "def..." }]
  }
}

Try it

Live preview only works when the API is running on your machine.

Run docker compose up and the Try-It panel will become interactive. Until then, copy the curl example below.