pageaudit.online

{
  "input": {
    "discoverable": true,
    "method": "POST",
    "pathParams": {
      "id": ""
    },
    "type": "http"
  },
  "output": {
    "schema": {
      "properties": {
        "gate": {
          "description": "Quanto sobrou da franquia depois deste run.",
          "properties": {
            "configured": {
              "description": "Se o Turnstile está configurado neste ambiente.",
              "type": "boolean"
            },
            "free_allowance": {
              "description": "Audits grátis por dia.",
              "type": "integer"
            },
            "free_remaining": {
              "description": "Quantos ainda restam hoje para este IP.",
              "type": "integer"
            },
            "ip": {
              "description": "IP visto pela borda, já mascarado.",
              "type": "string"
            },
            "needs_verification": {
              "description": "`true` quando a próxima chamada vai pedir Turnstile (humano) ou 402 (agente).",
              "type": "boolean"
            },
            "now": {
              "description": "Momento da consulta, em epoch.",
              "type": "integer"
            },
            "sitekey": {
              "description": "Sitekey do Turnstile, para o browser montar o desafio.",
              "type": "string"
            },
            "verified_until": {
              "description": "Até quando a verificação já feita vale.",
              "type": "integer"
            }
          },
          "type": "object"
        },
        "ok": {
          "description": "Sempre `true`.",
          "type": "boolean"
        },
        "result": {
          "description": "O relatório recém-gravado.",
          "properties": {
            "audit_id": {
              "description": "ID do audit.",
              "type": "string"
            },
            "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"
            },
            "created_at": {
              "description": "Quando o run aconteceu (UTC).",
              "type": "string"
            },
            "fixes": {
              "description": "A correção pronta de cada achado; audit gravado antes de existir recebe o cálculo na leitura.",
              "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": "Headers da resposta do alvo, como estavam no run.",
              "type": "object"
            },
            "issues": {
              "description": "Tudo que foi encontrado naquele run.",
              "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 gravados.",
              "items": {
                "type": "object"
              },
              "type": "array"
            },
            "score": {
              "description": "Nota de 0 a 100.",
              "type": "integer"
            },
            "share_slug": {
              "description": "Slug público, se este audit foi compartilhado.",
              "type": "string"
            },
            "summary": {
              "description": "O que a página declarava no momento do run.",
              "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 por tamanho na hora de gravar.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "url": {
              "description": "URL final auditada, depois de seguir os redirects.",
              "type": "string"
            }
          },
          "type": "object"
        },
        "tab": {
          "description": "A aba com a nota do run novo.",
          "properties": {
            "active": {
              "description": "Se é a aba em foco no workspace.",
              "type": "boolean"
            },
            "alias": {
              "description": "Rótulo que a pessoa deu à aba.",
              "type": "string"
            },
            "audit_id": {
              "description": "Audit do último run desta aba.",
              "type": "string"
            },
            "created_at": {
              "description": "Quando a aba foi aberta (UTC).",
              "type": "string"
            },
            "id": {
              "description": "ID da aba.",
              "type": "string"
            },
            "score": {
              "description": "Nota do último run.",
              "type": "integer"
            },
            "url": {
              "description": "URL que a aba acompanha.",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "type": "json"
  }
}