Obtenez des résultats de l'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
Les utilisateurs d'Axe Monitor peuvent générer une clé API dans Axe Account et récupérer les résultats des analyses pour les utiliser dans un autre système.
En savoir plus sur Premiers Pas.
Points de Terminaison
Tous les points de terminaison peuvent récupérer des informations avec des requêtes GET.
| Point de terminaison | But |
|---|---|
/scans |
Lister toutes les analyses auxquelles un utilisateur peut accéder. Vous permet de récupérer scanId. |
/scans/[scanId]/runs |
Lister tous les scans pour une analyse, avec des informations de vue d'ensemble. Vous permet de récupérer le runId. |
/scans/[scanId]/runs/[runId]/pages |
Informations détaillées sur la page pour un scan. |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
Problèmes d'accessibilité détaillés pour une page. |
/scans/[scanId]/runs/[runId]/issues |
Problèmes d'accessibilité détaillés pour un scan. |
Lister les Analyses pour un Utilisateur
Exemple de Requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>Exemple de Réponse
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}Remarque : La valeur ‘draft’ indique si un scan a été créé en tant que brouillon assisté par l'IA avec le Intégration Axe Monitor MCP. Il ne peut pas être modifié par l'API.
Exécutions de Scans pour une Analyse
Exemple de Requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Exemple de Requête
Paramètres Requis
| Nom | Type | Description |
|---|---|---|
| scanId | Entier | L'identifiant unique de l'analyse. |
Paramètres Optionnels
| Nom | Type | Description |
|---|---|---|
| needsReview | Chaîne | “true” ou “false” vous permet de contrôler si les problèmes “Besoin de révision” sont comptés dans la réponse. |
Exemple de Réponse
{
"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
}
]
}
]
}Remarque: Si votre analyse comporte une ou plusieurs phrases saisies dans le paramètre “Trouver le texte”, la réponse de l'API inclut un tableau findText.
Chaque entrée contient :
- La phrase saisie.
- Le nombre de pages où la phrase a été identifiée.
Détails de la Page pour une Exécution de Scan
Exemple de Requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>Paramètres de Chemin Requis
| Nom | Type | Description |
|---|---|---|
| scanId | Entier | L'identifiant unique de l'analyse. |
| runNumber | Entier | Le numéro spécifique de l'exécution du scan. |
Paramètres Optionnels de Requête
| Nom | Type | Description |
|---|---|---|
| statut | chaîne | Filtre les pages par statut (Complet, Échec). |
| trierPar | Chaîne | Spécifie la colonne par laquelle trier (titre, url). La valeur par défaut est titre. |
| ordre | Chaîne | Spécifie la direction du tri (asc ou desc). La valeur par défaut est desc. |
| crééAprès | Chaîne | Filtre par pages analysées après une certaine date. |
| crééAvant | Chaîne | Filtrer par pages scannées avant une certaine date. |
| testUrl | Chaîne | Filtrer par certaines pages testées. |
Exemple de Réponse
{
"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"
]
}
]
}
Remarque : Lorsque le paramètre "Trouver du texte" est activé pour le scan, le tableau contient toutes les phrases du paramètre „Trouver du texte“ qui ont été identifiées sur cette page.
Détails des problèmes pour une page
Exemple de Requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>Paramètres Requis
| Nom | Type | Description |
|---|---|---|
| scanId | Entier | L'identifiant unique de l'analyse. |
| runNumber | Entier | Le numéro spécifique de l'exécution du scan. |
| pageId | Entier | L'identifiant unique de la page. |
Paramètres Optionnels
| Nom | Type | Description |
|---|---|---|
| statut | chaîne | Filtrer les problèmes par statut (ouvert, corrigé ou ignoré). |
| trierPar | Chaîne | Indique la colonne par laquelle trier (testPageTitle, testUrl, selector, createdAt, impact ou status). La valeur par défaut est testPageTitle. |
| ordre | Chaîne | Spécifie la direction du tri (asc ou desc). La valeur par défaut est desc. |
| crééAprès | Chaîne | Filtrer par problèmes trouvés après une certaine date. |
| crééAvant | Chaîne | Filtrer par problèmes trouvés avant une certaine date. |
Exemple de Réponse
{
"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"
}
]
}Détails des problèmes pour un lancement de scan
Exemple de Requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>Paramètres Requis
| Nom | Type | Description |
|---|---|---|
| scanId | Entier | L'identifiant unique de l'analyse. |
| runNumber | Entier | Le numéro spécifique de l'exécution du scan. |
Paramètres Optionnels de Requête
| Nom | Type | Description |
|---|---|---|
| statut | chaîne | Filtrer les problèmes par statut (ouvert, corrigé ou ignoré). |
| trierPar | Chaîne | Indique la colonne par laquelle trier (testPageTitle, testUrl, selector, createdAt ou status). La valeur par défaut est testPageTitle. |
| ordre | Chaîne | Spécifie la direction du tri (asc ou desc). La valeur par défaut est desc. |
| pageId | Chaîne | Filtrer par l'identifiant unique de la page. |
| crééAprès | Chaîne | Filtrer par problèmes trouvés après une certaine date. |
| crééAvant | Chaîne | Filtrer par problèmes trouvés avant une certaine date. |
| testUrl | Chaîne | Filtrer par certaines pages testées. |
| ruleId | Chaîne | Filtrer par certains IDs de règles. |
Exemple de Réponse
{
"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"
}
]
}Erreurs
| Code d'état HTTP | Type d'erreur | Description |
|---|---|---|
| 401 | Non autorisé | L'utilisateur n'est pas authentifié ou n'a pas les droits d'accès. |
| 400 | Requête invalide | La requête contient des paramètres non valides. |
| 500 | Erreur interne du serveur | Une erreur s'est produite lors du traitement de la requête. |
Point de terminaison des versions d'Axe
Exemple de Requête
GET
GET /v1/axe-versions Paramètres Requis
| Nom | Type | Description |
|---|---|---|
| scanId | Entier | L'identifiant unique de l'analyse. |
| runNumber | Entier | Le numéro spécifique de l'exécution du scan. |
| pageId | Entier | L'identifiant unique de la page. |
Paramètres Optionnels de Requête
| Nom | Type | Requis | Description |
|---|---|---|---|
| statut | chaîne | Non | Filtrer les problèmes par statut (ouvert, corrigé ou ignoré). |
| trierPar | Chaîne | Non | Indique la colonne par laquelle trier (testPageTitle, testUrl, selector, createdAt ou status). La valeur par défaut est testPageTitle. |
| ordre | Chaîne | Non | Spécifie la direction du tri (asc ou desc). La valeur par défaut est desc. |
Schéma de réponse
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};Exemple de Réponse
{
"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"
}