Check a site before publishing

The editor's site check over the DRAFT: accessibility and search problems a publish would put live — pictures with no description (alt text), pages with no Google description, a page with no main heading or more than one, item headings with no section heading (a skipped level), text / button colors below WCAG AA (4.5 : 1), buttons with no words, and buttons or links to a page that isn't there. A heads-up only: publish_site never refuses for these. Each item says where it is (page_id / section_id) and why, in plain words (`reason`) plus the trade term (`detail`).

GET/api/v1/sites/{site_id}/check

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the sites:read scope — read sites, pages and sections.

sites:readRead onlyMCP tool: check_site

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required: The site's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/check' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "site_id": {
      "type": "string"
    },
    "count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "summary": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "picture",
              "description",
              "heading",
              "color",
              "link"
            ]
          },
          "target": {
            "type": "string",
            "enum": [
              "section",
              "page",
              "design",
              "settings"
            ],
            "description": "Where to fix it: a section, the page's search settings, the design's colors, or the site settings."
          },
          "label": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "page_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "page_title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "section_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "kind",
          "target",
          "label",
          "reason",
          "detail",
          "page_id",
          "page_title",
          "section_id"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "site_id",
    "count",
    "summary",
    "items"
  ],
  "additionalProperties": false
}