Compare staging with production

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-compare-sites"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/d23571fe-d62c-4493-bd5e-b3d8e2ef44a2/social-card.svg?v=3e7ae33eec8b" alt="Compare staging with production" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/compare_sites

Fetches the same paths on two origins — staging (a) and production (b), say — and lists every difference in what they tell search engines: status, robots, canonical (read on each side's own host), hreflang, title, H1 and structured data, with critical ones first and a Markdown summary. Paths default to the client's latest crawl (its shallowest pages, spread across templates) or, without a crawl, the links on b's home page; paths narrows it. sendCrawlAuthTo sends the client's set_crawl_auth credentials (basic auth, headers, cookies) to that side only, for a password-protected staging site. When one side's home redirects to the other's host (www to the apex), redirect names the status and target and nothing is diffed, since that side has no pages of its own; single paths that redirect across are listed in redirected. followRedirect: true follows that redirect instead of stopping: each path on the redirecting side is fetched to where it lands and compared with the same path on the other side (the redirect's destination), redirectMap lists where each landed, and a path the redirect sends elsewhere (the home page, a 404) or a temporary redirect shows as a change; redirect stays reported and followedRedirect says it was followed. Answers 'is staging ready to go live', 'what will the migration change' and 'does www still redirect every page to the same path'. No vendor charge; it fetches pages on the client's behalf, so it needs project:manage.

Parameters

Idempotency-Keystringheader
Any unique string, up to 200 characters. A retry with the same key and body is answered from the first answer (Idempotent-Replayed: true) for a day, so it never buys or writes twice; the same key with another body is refused.

Request body

application/json
clientIdstringrequired
astringrequired
The site under test, e.g. staging.
bstringrequired
The reference, e.g. production.
pathsstring[]
= []
maxPagesinteger
= 50
sendCrawlAuthTostring
a | b | none = a
followRedirectboolean
When one side's home redirects to the other's host, follow it and check each path lands on the same path there, instead of stopping.
= false
{
  "clientId": "string",
  "a": "string",
  "b": "string",
  "paths": [],
  "maxPages": 50,
  "sendCrawlAuthTo": "a",
  "followRedirect": false
}

Code samples

cURL
curl -X POST "https://seolyticize.com/api/v1/tools/compare_sites" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","a":"string","b":"string","paths":[],"maxPages":50,"sendCrawlAuthTo":"a","followRedirect":false}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The tool's result under data, and its meta.
Example
{
  "data": {},
  "meta": {
    "requestId": "string",
    "costMicros": 0,
    "cached": true,
    "cachedFrom": "string",
    "dataAsOf": "string",
    "sources": [
      "string"
    ],
    "partial": true,
    "next": [
      {
        "tool": "string",
        "args": {},
        "why": "string"
      }
    ],
    "nextCursor": "string",
    "dryRun": true
  }
}
Schema
datarequired
metaobjectrequired
Beside every answer: what it cost, whether it came from cache, how fresh it is, whether it is complete, and what to call next.
Show child parameters
requestIdstringrequired
costMicrosintegerrequired
Charged by this call, micro-USD (1,000,000 = $1).
cachedbooleanrequired
True when nothing was bought.
cachedFromstring
When the oldest cached answer used was bought.
dataAsOfstring
sourcesstring[]
partialbooleanrequired
True when the data is incomplete: a running crawl, unfinished days, unread pages.
nextobject[]required
Show child parameters
toolstring
argsobject
whystring
nextCursorstring
Pass as cursor for the next page.
dryRunboolean
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
X-Request-Idstring
The id to quote about this request.
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string",
  "code": "string",
  "next": "string",
  "requestId": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
codestring
A stable snake_case reason to branch on; GET /api/v1/errors lists them all.
nextstring
The call or step that fixes it, when there is one.
requestIdstring
Quote it when asking about a failure.
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
401 No key, or a key that is unknown or revoked.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
WWW-Authenticatestring
403 The key's role does not permit the tool, or the key may not reach the named client.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
404 No tool by that name.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
409 A request with this Idempotency-Key is still running.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
429 This key has used its window.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Retry-Afterinteger
Seconds to wait before retrying.
500 The request could not be completed.

Same as 400 · POST /api/v1/tools/compare_sites

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Updated