Draft & publish

Check the draft for problems before publishing

A read-only plan check over the draft: route and page counts, collection and template mistakes, redirect loops and chains, pages whose bytes are missing, pending third-party integrations and SEO notes. Run it before a large build and again before publishSite. It reads the whole site, so call it on demand rather than in a loop. It records a draft SEO snapshot, which the dashboard shows.

post/api/v1/sites/{slug}/preflight

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/preflight
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Request body

requiredRoutesinteger

How many routes you plan to add. It is counted against the Free plan's soft limit of about 10 routes.

requiredAssetsinteger

How many assets you plan to upload. Used to remind you to upload them before publishing.

Example request

{
  "requiredRoutes": 12
}

Response

The findings. Read ok and suggestions.

okboolean required

False when any blocking suggestion exists. Suggestions ending in (advisory), (optional) or (info) never flip it.

slugstring required
collectionsobject required

The site's collection index by prefix (item count, build state, data size).

suggestionsstring[] required

Plain-language findings: collection and template problems, redirect loops, SEO notes, missing page bytes.

blockingstring[] required

The suggestions that made ok false, word for word. Empty when ok is true. Fix these first.

Example response

{
  "integrations": {
    "pending": [
      {
        "vendor": "gtm"
      }
    ]
  }
}

Changes

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