Obtenha Resultados da API
This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data
Os usuários do Axe Monitor podem gerar uma chave de API no Axe Account e recuperar resultados de varredura para usar em outro sistema.
Saiba mais sobre Primeiros passos.
Endpoints
Todos os endpoints podem recuperar informações com solicitações GET.
| Endpoint | Propósito |
|---|---|
/scans |
Listar todas as varreduras que um usuário pode acessar. Permite recuperar scanId. |
/scans/[scanId]/runs |
Listar todas as execuções de varredura para uma varredura, com informações gerais da varredura. Permite recuperar runId. |
/scans/[scanId]/runs/[runId]/pages |
Informações detalhadas da página para uma execução de varredura. |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
Problemas de acessibilidade detalhados para uma página. |
/scans/[scanId]/runs/[runId]/issues |
Problemas de acessibilidade detalhados para uma execução de varredura. |
Listar Varreduras para um Usuário
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>Exemplo de Resposta
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}Nota: O valor ‘rascunho’ refere-se a se uma varredura foi criada como um rascunho assistido por IA com o Integração do Axe Monitor MCP. Ele não pode ser editado pela API.
Execuções de Varredura para uma Varredura
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Exemplo de Solicitação
Parâmetros Obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| scanId | Inteiro | O identificador único da varredura. |
Parâmetros Opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| needsReview | String | “true” ou “false” permite controlar se as questões “Precisa de revisão” são contabilizadas na resposta. |
Exemplo de Resposta
{
"scanRuns": [
{
"runNumber": 1,
"status": "Completed",
"queuedAt": "2025-08-21T06:50:27Z",
"startedAt": "2025-08-21T06:50:37Z",
"completedAt": "2025-08-21T06:51:52Z",
"axeVersion": "4.10.3",
"standard": "WCAG 2.1 AA",
"score": 0,
"issues": {
"total": 392,
"critical": 77,
"serious": 315,
"moderate": 0,
"minor": 0
},
"pages": {
"total": 18,
"completed": 17,
"critical": 17
},
"violationGroups": [
{
"name": "color",
"pageCount": 17
},
{
"name": "forms",
"pageCount": 17
},
{
"name": "name-role-value",
"pageCount": 10
},
{
"name": "parsing",
"pageCount": 1
},
{
"name": "text-alternatives",
"pageCount": 13
}
]
}
]
}Nota: Se a sua varredura tiver uma ou mais frases inseridas na configuração “Encontrar Texto”, a resposta da API incluirá um array findText.
Cada entrada contém:
- A frase inserida.
- O número de páginas onde a frase foi identificada.
Detalhes da Página para uma Execução de Varredura
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>Parâmetros de Caminho Obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| scanId | Inteiro | O identificador único da varredura. |
| runNumber | Inteiro | O número específico da execução da varredura. |
Parâmetros Opcionais de Solicitação
| Nome | Tipo | Descrição |
|---|---|---|
| status | string | Filtra páginas por status (Concluído, Falhou). |
| sortBy | String | Especifica a coluna para ordenar (título, url). O valor padrão é título. |
| order | String | Especifica a direção da ordenação (asc ou desc). O valor padrão é desc. |
| createdAfter | String | Filtra por páginas escaneadas após uma certa data. |
| createdBefore | String | Filtrar por páginas analisadas antes de uma determinada data. |
| testUrl | String | Filtrar por determinadas páginas testadas. |
Exemplo de Resposta
{
"pages": [
{
"pageId": 0,
"testUrl": "string",
"testPageTitle": "string",
"reasonForFailure": "string",
"totalCriticalIssues": 0,
"totalSeriousIssues": 0,
"totalModerateIssues": 0,
"totalMinorIssues": 0,
"totalNeedsReview": 0,
"totalFixedIssues": 0,
"totalOpenIssues": 0,
"health": "string",
"status": "string",
"scriptName": "string",
"scriptStep": 0,
"template": true,
"createdAt": "2026-11-03T16:49:37.490Z",
"domainUrl": "string",
"findText": [
"string"
]
}
]
}
Nota: Quando a configuração de Encontrar Texto está ativada para a análise, o array contém todas as frases da configuração “Encontrar Texto” que foram identificadas nessa página.
Detalhes do Problema para uma Página
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>Parâmetros Obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| scanId | Inteiro | O identificador único da varredura. |
| runNumber | Inteiro | O número específico da execução da varredura. |
| pageId | Inteiro | O identificador único da página. |
Parâmetros Opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| status | string | Filtra problemas por status (aberto, corrigido ou ignorado). |
| sortBy | String | Especifica a coluna pela qual ordenar (testPageTitle, testUrl, selector, createdAt, impact ou status). O valor padrão é testPageTitle. |
| order | String | Especifica a direção da ordenação (asc ou desc). O valor padrão é desc. |
| createdAfter | String | Filtrar por problemas encontrados após uma determinada data. |
| createdBefore | String | Filtrar por problemas encontrados antes de uma determinada data. |
Exemplo de Resposta
{
"issues": [
{
"issueId": 0,
"ruleId": "string",
"axeRuleId": "string",
"successCriteria": "wcag143",
"description": "string",
"help": "string",
"helpUrl": "string",
"impact": "string",
"issueGrouping": "string",
"needsReview": true,
"isExperimental": true,
"isManual": true,
"summary": "string",
"selector": [
"string"
],
"source": "string",
"tags": [
"string"
],
"igt": "string",
"testName": "string",
"createdAt": "2026-11-03T17:08:14.717Z",
"testUrl": "string",
"testPageTitle": "string",
"status": "string"
}
]
}Detalhes do Problema para uma Execução de Análise
Exemplo de Solicitação
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>Parâmetros Obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| scanId | Inteiro | O identificador único da varredura. |
| runNumber | Inteiro | O número específico da execução da varredura. |
Parâmetros Opcionais de Solicitação
| Nome | Tipo | Descrição |
|---|---|---|
| status | string | Filtra problemas por status (aberto, corrigido ou ignorado). |
| sortBy | String | Especifica a coluna pela qual ordenar (testPageTitle, testUrl, selector, createdAt ou status). O valor padrão é testPageTitle. |
| order | String | Especifica a direção da ordenação (asc ou desc). O valor padrão é desc. |
| pageId | String | Filtrar pelo identificador único da página. |
| createdAfter | String | Filtrar por problemas encontrados após uma determinada data. |
| createdBefore | String | Filtrar por problemas encontrados antes de uma determinada data. |
| testUrl | String | Filtrar por determinadas páginas testadas. |
| ruleId | String | Filtrar por determinados IDs de regras. |
Exemplo de Resposta
{
"issues": [
{
"issueId": 0,
"ruleId": "string",
"axeRuleId": "string",
"successCriteria": "wcag143",
"description": "string",
"help": "string",
"helpUrl": "string",
"impact": "string",
"issueGrouping": "string",
"needsReview": true,
"isExperimental": true,
"isManual": true,
"summary": "string",
"selector": [
"string"
],
"source": "string",
"tags": [
"string"
],
"igt": "string",
"testName": "string",
"createdAt": "2026-11-03T17:04:46.552Z",
"testUrl": "string",
"testPageTitle": "string",
"status": "string"
}
]
}Erros
| Código de Status HTTP | Tipo de Erro | Descrição |
|---|---|---|
| 401 | Não Autorizado | O usuário não está autenticado ou não possui direitos de acesso. |
| 400 | Requisição Inválida | A requisição contém parâmetros inválidos. |
| 500 | Erro Interno do Servidor | Ocorreu um erro ao processar a requisição. |
Endpoint de Obtenção de Versões do Axe
Exemplo de Solicitação
GET
GET /v1/axe-versions Parâmetros Obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| scanId | Inteiro | O identificador único da varredura. |
| runNumber | Inteiro | O número específico da execução da varredura. |
| pageId | Inteiro | O identificador único da página. |
Parâmetros Opcionais de Solicitação
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| status | string | Não | Filtra problemas por status (aberto, corrigido ou ignorado). |
| sortBy | String | Não | Especifica a coluna pela qual ordenar (testPageTitle, testUrl, selector, createdAt ou status). O valor padrão é testPageTitle. |
| order | String | Não | Especifica a direção da ordenação (asc ou desc). O valor padrão é desc. |
Esquema de Resposta
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};Exemplo de Resposta
{
"versions": [
{
"version": "latest",
"supported": true,
"tags": [
"wcag22a",
"wcag22aa",
"wcag22aaa",
"wcag21a",
"wcag21aa",
"wcag21aaa",
"wcag2a",
"wcag2aa",
"wcag2aaa",
"section508",
"EN-301-549",
"TTv5",
"RGAAv4",
"best-practice"
]
},
{
"version": "4.12.1",
"supported": true,
"tags": [
"wcag22a",
"wcag22aa",
"wcag22aaa",
"wcag21a",
"wcag21aa",
"wcag21aaa",
"wcag2a",
"wcag2aa",
"wcag2aaa",
"section508",
"EN-301-549",
"TTv5",
"RGAAv4",
"best-practice"
]
}
],
"default": "latest"
}