beta.audit.wordlift.io

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Public http(s) URL of the website to audit, for example https://example.com."
    },
    "archetype": {
      "type": "string",
      "enum": [
        "commerce-retail",
        "publisher-content",
        "travel-hospitality",
        "finance-insurance",
        "saas",
        "other"
      ],
      "description": "Optional operating archetype to use instead of the inferred one."
    },
    "depth": {
      "type": "string",
      "enum": [
        "basic",
        "deep"
      ],
      "description": "Accepted for older callers and ignored. There is one scan: it reads five representative pages and asks for nothing."
    },
    "email": {
      "type": "string",
      "description": "Optional. Where to send the finished report; delivery is all it buys, and the scan is the same without it. Ask the person for their address — never guess one, and never reuse an address from elsewhere in the conversation without asking."
    },
    "fresh": {
      "type": "boolean",
      "description": "Read the site again even if it was audited in the last day. By default a recent audit of the same site is reused, so a second look costs nothing; set this to re-verify after a change."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}