Obtener Resultados de la 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
Los usuarios de Axe Monitor pueden generar una clave API en Axe Account y recuperar resultados de escaneo para usarlos en otro sistema.
Obtenga más información sobre Primeros pasos.
Puntos Finales
Todos los puntos finales pueden recuperar información con solicitudes GET.
| Punto Final | Propósito |
|---|---|
/scans |
Listar todos los escaneos a los que un usuario puede acceder. Le permite recuperar scanId. |
/scans/[scanId]/runs |
Listar todas las ejecuciones de escaneo para un escaneo, con información general del escaneo. Le permite recuperar el runId. |
/scans/[scanId]/runs/[runId]/pages |
Información detallada de la página para una ejecución de escaneo. |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
Problemas de accesibilidad detallados para una página. |
/scans/[scanId]/runs/[runId]/issues |
Problemas de accesibilidad detallados para una ejecución de escaneo. |
Listar Escaneos para un Usuario
Solicitud de Ejemplo
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>Respuesta de Ejemplo
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}Nota: El valor ‘borrador’ se refiere a si un escaneo fue creado como un borrador asistido por IA con el Integración de Axe Monitor MCP. No se puede editar mediante la API.
Ejecuciones de Escaneo para un Escaneo
Solicitud de Ejemplo
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Solicitud de Ejemplo
Parámetros Requeridos
| Nombre | Tipo | Descripción |
|---|---|---|
| scanId | Entero | El identificador único del escaneo. |
Parámetros Opcionales
| Nombre | Tipo | Descripción |
|---|---|---|
| needsReview | Cadena | “true” o “false” le permite controlar si se cuentan los problemas de “Necesita revisión” en la respuesta. |
Respuesta de Ejemplo
{
"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: Si su escaneo tiene una o más frases ingresadas en la configuración “Buscar Texto”, la respuesta de la API incluye un arreglo findText.
Cada entrada contiene:
- La frase ingresada.
- El número de páginas donde se identificó la frase.
Detalles de Página para una Ejecución de Escaneo
Solicitud de Ejemplo
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>Parámetros de Ruta Requeridos
| Nombre | Tipo | Descripción |
|---|---|---|
| scanId | Entero | El identificador único del escaneo. |
| runNumber | Entero | El número específico de ejecución del escaneo. |
Parámetros Opcionales de Solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| estado | cadena | Filtra las páginas por estado (Completado, Fallido). |
| ordenarPor | Cadena | Especifica la columna para ordenar (título, url). El valor por defecto es título |
| orden | Cadena | Especifica la dirección del orden (asc o desc). El valor por defecto es desc. |
| creadoDespués | Cadena | Filtrar por páginas escaneadas después de una cierta fecha. |
| creadoAntes | Cadena | Filtrar por páginas escaneadas antes de una fecha determinada. |
| testUrl | Cadena | Filtrar por ciertas páginas probadas. |
Respuesta de Ejemplo
{
"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: Cuando la configuración de localización de texto está activada para el escaneo, el arreglo contiene todas las frases de la configuración de “Localización de Texto” que fueron identificadas en esa página.
Detalles de Problemas para una Página
Solicitud de Ejemplo
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>Parámetros Requeridos
| Nombre | Tipo | Descripción |
|---|---|---|
| scanId | Entero | El identificador único del escaneo. |
| runNumber | Entero | El número específico de ejecución del escaneo. |
| pageId | Entero | El identificador único de la página. |
Parámetros Opcionales
| Nombre | Tipo | Descripción |
|---|---|---|
| estado | cadena | Filtra problemas por estado (abierto, corregido o ignorado). |
| ordenarPor | Cadena | Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt, impact o status). El valor predeterminado es testPageTitle. |
| orden | Cadena | Especifica la dirección del orden (asc o desc). El valor por defecto es desc. |
| creadoDespués | Cadena | Filtrar por problemas encontrados después de una fecha determinada. |
| creadoAntes | Cadena | Filtrar por problemas encontrados antes de una fecha determinada. |
Respuesta de Ejemplo
{
"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"
}
]
}Detalles de Problemas para una Ejecución de Escaneo
Solicitud de Ejemplo
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>Parámetros Requeridos
| Nombre | Tipo | Descripción |
|---|---|---|
| scanId | Entero | El identificador único del escaneo. |
| runNumber | Entero | El número específico de ejecución del escaneo. |
Parámetros Opcionales de Solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| estado | cadena | Filtra problemas por estado (abierto, corregido o ignorado). |
| ordenarPor | Cadena | Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt o status). El valor predeterminado es testPageTitle. |
| orden | Cadena | Especifica la dirección del orden (asc o desc). El valor por defecto es desc. |
| pageId | Cadena | Filtrar por el identificador único de la página. |
| creadoDespués | Cadena | Filtrar por problemas encontrados después de una fecha determinada. |
| creadoAntes | Cadena | Filtrar por problemas encontrados antes de una fecha determinada. |
| testUrl | Cadena | Filtrar por ciertas páginas probadas. |
| ruleId | Cadena | Filtrar por ciertos IDs de regla. |
Respuesta de Ejemplo
{
"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"
}
]
}Errores
| Código de Estado HTTP | Tipo de Error | Descripción |
|---|---|---|
| 401 | No Autorizado | El usuario no está autenticado o carece de derechos de acceso. |
| 400 | Solicitud Inválida | La solicitud contiene parámetros inválidos. |
| 500 | Error Interno del Servidor | Se produjo un error al procesar la solicitud. |
Punto de Acceso de Versiones de Axe
Solicitud de Ejemplo
GET
GET /v1/axe-versions Parámetros Requeridos
| Nombre | Tipo | Descripción |
|---|---|---|
| scanId | Entero | El identificador único del escaneo. |
| runNumber | Entero | El número específico de ejecución del escaneo. |
| pageId | Entero | El identificador único de la página. |
Parámetros Opcionales de Solicitud
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
| estado | cadena | No | Filtra problemas por estado (abierto, corregido o ignorado). |
| ordenarPor | Cadena | No | Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt o status). El valor predeterminado es testPageTitle. |
| orden | Cadena | No | Especifica la dirección del orden (asc o desc). El valor por defecto es desc. |
Esquema de Respuesta
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};Respuesta de Ejemplo
{
"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"
}