Ergebnisse von der API abrufen
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
Axe Monitor-Benutzer können in Axe Account einen API-Schlüssel generieren und Scan-Ergebnisse abrufen, um sie in einem anderen System zu verwenden.
Erfahren Sie mehr über Erste Schritte.
Endpoints
Alle Endpoints können Informationen mit GET-Anfragen abrufen.
| Endpoint | Zweck |
|---|---|
/scans |
Listet alle Scans auf, auf die ein Benutzer zugreifen kann. Ermöglicht das Abrufen von scanId. |
/scans/[scanId]/runs |
Listet alle Scan-Durchläufe für einen Scan auf, mit Übersichtsinformationen zu den Scans. Ermöglicht das Abrufen der runId. |
/scans/[scanId]/runs/[runId]/pages |
Detaillierte Seiteninformationen für einen Scan-Durchlauf. |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
Detaillierte Barrierefreiheitsprobleme für eine Seite. |
/scans/[scanId]/runs/[runId]/issues |
Detaillierte Barrierefreiheitsprobleme für einen Scan-Durchlauf. |
Scans für einen Benutzer auflisten
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>Beispielantwort
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}Hinweis: Der Wert ‚Entwurf‘ bezieht sich darauf, ob ein Scan als KI-unterstützter Entwurf mit der Axe Monitor MCP-Integration erstellt wurde. Es kann nicht von der API bearbeitet werden.
Scan-Durchläufe für einen Scan
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Beispielanfrage
Erforderliche Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
Optionale Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| needsReview | String | „true“ oder „false“ ermöglicht es Ihnen zu steuern, ob „Überprüfung erforderlich“-Probleme in der Antwort enthalten sind. |
Beispielantwort
{
"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
}
]
}
]
}Hinweis: Wenn Ihr Scan ein oder mehrere in der Einstellung „Text finden“ eingegebene Phrasen enthält, beinhaltet die API-Antwort ein findText-Array.
Jeder Eintrag enthält:
- Die eingegebene Phrase.
- Die Anzahl der Seiten, auf denen die Phrase identifiziert wurde.
Seitendetails für einen Scan-Durchlauf
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>Erforderliche Pfadparameter
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
| runNumber | Integer | Die spezifische Durchlaufnummer des Scans. |
Optionale Anforderungsparameter
| Name | Typ | Beschreibung |
|---|---|---|
| status | string | Filtert Seiten nach Status (Abgeschlossen, Fehlgeschlagen). |
| sortBy | String | Gibt die Spalte an, nach der sortiert werden soll (Titel, URL). Standardwert ist Titel. |
| order | String | Gibt die Sortierrichtung an (asc oder desc). Standardwert ist desc. |
| createdAfter | String | Filtert nach Seiten, die nach einem bestimmten Datum gescannt wurden. |
| createdBefore | String | Filtern nach Seiten, die vor einem bestimmten Datum gescannt wurden. |
| testUrl | String | Filtern nach bestimmten getesteten Seiten. |
Beispielantwort
{
"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"
]
}
]
}
Hinweis: Wenn die Option „Text finden“ für den Scan aktiviert ist, enthält das Array alle im Rahmen der Einstellung „Text finden“ auf dieser Seite identifizierten Phrasen.
Problemdetails für eine Seite
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>Erforderliche Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
| runNumber | Integer | Die spezifische Durchlaufnummer des Scans. |
| pageId | Integer | Die eindeutige Kennung der Seite. |
Optionale Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| status | string | Filtert Probleme nach Status (offen, behoben oder ignoriert). |
| sortBy | String | Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, selector, createdAt, impact oder status). Standardwert ist testPageTitle. |
| order | String | Gibt die Sortierrichtung an (asc oder desc). Standardwert ist desc. |
| createdAfter | String | Filtern nach Problemen, die nach einem bestimmten Datum gefunden wurden. |
| createdBefore | String | Filtern nach Problemen, die vor einem bestimmten Datum gefunden wurden. |
Beispielantwort
{
"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"
}
]
}Problemdetails für einen Scanlauf
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>Erforderliche Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
| runNumber | Integer | Die spezifische Durchlaufnummer des Scans. |
Optionale Anforderungsparameter
| Name | Typ | Beschreibung |
|---|---|---|
| status | string | Filtert Probleme nach Status (offen, behoben oder ignoriert). |
| sortBy | String | Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, selector, createdAt oder status). Standardwert ist testPageTitle. |
| order | String | Gibt die Sortierrichtung an (asc oder desc). Standardwert ist desc. |
| pageId | String | Filtern nach der eindeutigen Kennung der Seite. |
| createdAfter | String | Filtern nach Problemen, die nach einem bestimmten Datum gefunden wurden. |
| createdBefore | String | Filtern nach Problemen, die vor einem bestimmten Datum gefunden wurden. |
| testUrl | String | Filtern nach bestimmten getesteten Seiten. |
| ruleId | String | Filtern nach bestimmten Regel-IDs. |
Beispielantwort
{
"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"
}
]
}Fehler
| HTTP-Statuscode | Fehlertyp | Beschreibung |
|---|---|---|
| 401 | Nicht autorisiert | Der Benutzer ist nicht authentifiziert oder hat keine Zugriffsrechte. |
| 400 | Ungültige Anfrage | Die Anfrage enthält ungültige Parameter. |
| 500 | Interner Serverfehler | Beim Bearbeiten der Anfrage ist ein Fehler aufgetreten. |
Axe-Versions-Endpunkt abrufen
Beispielanfrage
GET
GET /v1/axe-versions Erforderliche Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
| runNumber | Integer | Die spezifische Durchlaufnummer des Scans. |
| pageId | Integer | Die eindeutige Kennung der Seite. |
Optionale Anforderungsparameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| status | string | Nein | Filtert Probleme nach Status (offen, behoben oder ignoriert). |
| sortBy | String | Nein | Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, selector, createdAt oder status). Standardwert ist testPageTitle. |
| order | String | Nein | Gibt die Sortierrichtung an (asc oder desc). Standardwert ist desc. |
Antwortschema
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};Beispielantwort
{
"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"
}