comparisons

Build the comparison of two crawls

Queue the build of the comparison of two crawls on the v2 model as a background job (seconds to minutes at 1M URLs), and answer at once. Defaults to the newest accepted v2 crawl against the one before it. The build uses the site's saved URL mapping and Change Detection settings. Repeating is harmless: a rebuild replaces the previous build, which stays readable until it lands. It uses no crawl quota. Next: read comparisons_get with the same pair until its state is built, or changes_get for the pages that came and went.

post/v1/sites/{site}/comparison

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/comparison
  • Auth: HTTP bearer

Path parameters

sitestring required

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

Request body

prev_seqinteger

The earlier crawl; omit for the accepted v2 crawl before the current one.

curr_seqinteger

The later crawl; omit for the site's newest accepted v2 crawl.

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Build the comparison of two crawls

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

queuedtrue required
site_idstring required

The canonical id of the site.

prev_seqinteger required
curr_seqinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.