Check a deploy before it ships

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-check-deploy"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/cb00247d-ce39-47ff-9209-c7dfaf3c7e91/social-card.svg?v=3e7ae33eec8b" alt="Check a deploy before it ships" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/check_deploy

Fetches pages now and compares what they tell search engines (status, robots, canonical, hreflang, title, H1, structured data types; and, against crawls that recorded them, meta description, Open Graph tags, structured data values, H2 outline and copy) with the latest complete crawl's snapshot of the same paths, or the complete crawl baselineCrawlId names (from list_crawls), to compare against a crawl from before a release; baseline says which crawl was used and when it ran, and notes warns when the latest crawl started before the last recorded deploy (deploy hook or deploy annotation), so the baseline may already include that release. Give previewUrl (a deploy preview or staging origin: the crawl's pages, one or more per template, are fetched on that host, up to maxUrls) or urls (specific addresses, on production or a preview; matched by path). Canonicals and hreflang on the preview host are read as the production host, so only real changes show. passed is false when anything at or above failOn (default critical: noindex added, canonical changed, title dropped, a page now 4xx/5xx, hreflang lost, a page unreachable) changed; markdown is a ready pull-request comment. The client's set_crawl_auth credentials are sent to the preview host too, so a password-protected preview can be checked. Used by the Seolyticize GitHub Action. Answers 'will this deploy hurt SEO' and 'did the release noindex anything'. 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
previewUrlstring
= null
urlsstring[]
= []
maxUrlsinteger
= 50
failOnstring
critical | warning | notice = critical
baselineCrawlIdstring
A complete crawl of this client to compare with, from list_crawls; default the latest complete one.
= null
{
  "clientId": "string",
  "previewUrl": null,
  "urls": [],
  "maxUrls": 50,
  "failOn": "critical",
  "baselineCrawlId": null
}

Code samples

cURL
curl -X POST "https://seolyticize.com/api/v1/tools/check_deploy" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","previewUrl":null,"urls":[],"maxUrls":50,"failOn":"critical","baselineCrawlId":null}'
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/check_deploy

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/check_deploy

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/check_deploy

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/check_deploy

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/check_deploy

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/check_deploy

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/check_deploy

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