pageaudit.online

{
  "input": {
    "bodyFields": {
      "cf_turnstile_response": "",
      "guest_token": "",
      "url": ""
    },
    "bodyType": "json",
    "discoverable": true,
    "method": "POST",
    "type": "http"
  },
  "output": {
    "schema": {
      "description": "O relatório de uma auditoria: nota, achados e tudo que foi observado na página.",
      "properties": {
        "_links": {
          "description": "Este audit, o patch, o compartilhamento e o índice da API.",
          "properties": {
            "api_index": {
              "description": "Índice auto-descrito da API.",
              "type": "string"
            },
            "patch": {
              "description": "`GET /api/audits/:id/patch` — o patch consolidado deste audit.",
              "type": "string"
            },
            "self": {
              "description": "Este audit, para reler sem re-auditar.",
              "type": "string"
            },
            "share": {
              "description": "Onde publicar este audit num slug público.",
              "type": "string"
            }
          },
          "type": "object"
        },
        "counts": {
          "description": "Quantos achados de cada severidade.",
          "properties": {
            "errors": {
              "description": "Achados graves.",
              "type": "integer"
            },
            "info": {
              "description": "Observações sem gravidade.",
              "type": "integer"
            },
            "warnings": {
              "description": "Achados que merecem atenção.",
              "type": "integer"
            }
          },
          "type": "object"
        },
        "fixes": {
          "description": "A correção pronta de cada achado, sem modelo — colar, preencher ou decidir. O consolidado está em `_links.patch`.",
          "items": {
            "description": "A correção pronta de um achado. `classe` diz se é para colar, para preencher ou para decidir.",
            "properties": {
              "alvo": {
                "description": "Onde aplicar: `head`, `corpo`, `img`, `arquivo` ou `pagina` (instrução).",
                "type": "string"
              },
              "arquivo": {
                "description": "`path` e `conteudo` quando a correção é um arquivo na raiz do host.",
                "type": "object"
              },
              "classe": {
                "description": "`deterministico` sai inteira da página; `molde` tem placeholder `{{…}}`; `sem_patch` é instrução.",
                "type": "string"
              },
              "code": {
                "description": "O mesmo `code` do achado (`Achado.code`).",
                "type": "string"
              },
              "fonte": {
                "description": "De onde o valor saiu, ou o que a página já tinha (para o molde ou para conferir o corte).",
                "type": "string"
              },
              "nota": {
                "description": "Como aplicar, ou o que decidir.",
                "type": "string"
              },
              "severity": {
                "description": "Gravidade do achado de origem.",
                "type": "string"
              },
              "snippet": {
                "description": "A tag pronta (ou com placeholder). `null` em arquivo e em `sem_patch`.",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "headers": {
          "description": "Todos os headers da resposta do alvo. `Set-Cookie` é removido de propósito: é credencial de terceiro.",
          "type": "object"
        },
        "htmlTruncated": {
          "description": "`true` quando a página passou de 2 MB e foi lida só até ali.",
          "type": "boolean"
        },
        "id": {
          "description": "ID do audit gravado; `null` quando o banco não estava disponível.",
          "type": "string"
        },
        "issues": {
          "description": "Tudo que foi encontrado, do mais grave para o menos.",
          "items": {
            "description": "Um problema (ou acerto) encontrado na página.",
            "properties": {
              "code": {
                "description": "Código estável do check, ex. `title_missing`. É por ele que se filtra.",
                "type": "string"
              },
              "message": {
                "description": "O achado em uma frase, pronta para mostrar a uma pessoa.",
                "type": "string"
              },
              "severity": {
                "description": "Gravidade do achado.",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "jsonLd": {
          "description": "Os blocos JSON-LD crus, como estavam na página.",
          "items": {
            "type": "object"
          },
          "type": "array"
        },
        "jsonLdStored": {
          "description": "Quantos blocos sobreviveram ao teto de tamanho — compare com `summary.jsonLdBlocks`.",
          "type": "integer"
        },
        "quota": {
          "description": "Quanto ainda é grátis e quanto custa passar disso.",
          "properties": {
            "free_per_day": {
              "description": "Audits grátis por IP por dia.",
              "type": "integer"
            },
            "price_usd": {
              "description": "Preço do audit além da franquia, em USD.",
              "type": "number"
            }
          },
          "type": "object"
        },
        "score": {
          "description": "Nota de 0 a 100, calculada dos achados abaixo.",
          "type": "integer"
        },
        "summary": {
          "description": "O que a página declara: título, meta, canonical, OG, headings, links…",
          "properties": {
            "canonical": {
              "description": "URL canônica declarada pela página.",
              "type": "string"
            },
            "charset": {
              "description": "Codificação declarada.",
              "type": "string"
            },
            "contentType": {
              "description": "Content-Type da resposta final.",
              "type": "string"
            },
            "favicon": {
              "description": "URL do favicon encontrado.",
              "type": "string"
            },
            "faviconSource": {
              "description": "Como o favicon foi achado: declarado ou pelo caminho padrão.",
              "type": "string"
            },
            "finalUrl": {
              "description": "URL depois de seguir todos os redirects.",
              "type": "string"
            },
            "h1s": {
              "description": "Todos os `<h1>` da página, na ordem.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "hreflang": {
              "description": "As alternativas de idioma declaradas.",
              "items": {
                "type": "object"
              },
              "type": "array"
            },
            "images": {
              "description": "Contagem de imagens e quantas estão sem `alt`.",
              "type": "object"
            },
            "jsonLdBlocks": {
              "description": "Quantos blocos `<script type=application/ld+json>` existiam.",
              "type": "integer"
            },
            "jsonLdCount": {
              "description": "Quantos nós JSON-LD a página tinha.",
              "type": "integer"
            },
            "jsonLdDropped": {
              "description": "`true` quando nós foram descartados por passarem do teto.",
              "type": "boolean"
            },
            "jsonLdTypes": {
              "description": "Os `@type` encontrados, ex. `Organization`, `WebSite`.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "lang": {
              "description": "Idioma declarado em `<html lang>`.",
              "type": "string"
            },
            "legacy": {
              "description": "Markup antigo ainda presente (ex. `<font>`, tabelas de layout).",
              "type": "object"
            },
            "links": {
              "description": "Contagem de links internos, externos e sem texto.",
              "type": "object"
            },
            "metaDescription": {
              "description": "Conteúdo de `<meta name=description>`.",
              "type": "string"
            },
            "openGraph": {
              "description": "As tags `og:*` encontradas, chave por chave.",
              "type": "object"
            },
            "redirects": {
              "description": "A cadeia de redirects percorrida até a URL final.",
              "items": {
                "type": "object"
              },
              "type": "array"
            },
            "robots": {
              "description": "Conteúdo de `<meta name=robots>`.",
              "type": "string"
            },
            "robotsTxt": {
              "description": "O que o `robots.txt` da origem diz sobre esta URL.",
              "type": "object"
            },
            "sitemap": {
              "description": "Se a URL aparece no sitemap declarado pela origem.",
              "type": "object"
            },
            "status": {
              "description": "Status HTTP final do alvo.",
              "type": "integer"
            },
            "title": {
              "description": "Conteúdo de `<title>`.",
              "type": "string"
            },
            "twitter": {
              "description": "As tags `twitter:*` encontradas.",
              "type": "object"
            },
            "viewport": {
              "description": "Conteúdo de `<meta name=viewport>`.",
              "type": "string"
            },
            "words": {
              "description": "Palavras no conteúdo visível.",
              "type": "integer"
            }
          },
          "type": "object"
        },
        "truncated": {
          "description": "O que foi cortado e por quê: `jsonld_size`, `jsonld_nodes_over_50`, `result_size`. Vazio quer dizer nada cortado.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "type": "json"
  }
}