Resultaten opvragen via de 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
Axe Monitor-gebruikers kunnen een API-sleutel genereren in Axe Account en scanzesultaten ophalen om in een ander systeem te gebruiken.
Meer informatie over Aan de slag.
Endpoints
Alle endpoints kunnen informatie ophalen met GET-verzoeken.
| Endpoint | Doel |
|---|---|
/scans |
Alle scans weergeven die een gebruiker kan openen. Hiermee kunt u scanId. ophalen |
/scans/[scanId]/runs |
Alle scan-uitvoeringen voor een scan weergeven, met overzichtsinformatie van de scan. Hiermee kunt u de runId. ophalen |
/scans/[scanId]/runs/[runId]/pages |
Gedetailleerde paginainformatie voor een scan-uitvoering. |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
Gedetailleerde toegankelijkheidsproblemen voor een pagina. |
/scans/[scanId]/runs/[runId]/issues |
Gedetailleerde toegankelijkheidsproblemen voor een scan-uitvoering. |
Scans voor een gebruiker weergeven
Voorbeeldverzoek
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>Voorbeeldantwoord
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}Opmerking: De waarde ‘concept’ verwijst naar of een scan als AI-ondersteund concept is gemaakt met de Axe Monitor MCP-integratie. Het kan niet worden bewerkt door de API.
Scan-uitvoeringen voor een scan
Voorbeeldverzoek
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Voorbeeldverzoek
Vereiste parameters
| Naam | Type | Beschrijving |
|---|---|---|
| scanId | Integer | De unieke identificatie van de scan. |
Optionele parameters
| Naam | Type | Beschrijving |
|---|---|---|
| needsReview | String | “true” of “false” stelt u in staat om te bepalen of „Beoordeling nodig“ kwesties worden meegeteld in het antwoord. |
Voorbeeldantwoord
{
"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
}
]
}
]
}Opmerking: Als uw scan een of meer zinnen heeft ingevoerd in de instelling „Tekst zoeken“, bevat het API-antwoord een findText-array.
Elke invoer bevat:
- De ingevoerde zin.
- Het aantal pagina's waar de zin is geïdentificeerd.
Paginadetails voor een scan-uitvoering
Voorbeeldverzoek
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>Vereiste padparameters
| Naam | Type | Beschrijving |
|---|---|---|
| scanId | Integer | De unieke identificatie van de scan. |
| runNumber | Integer | Het specifieke uitvoeringsnummer van de scan. |
Optionele verzoekparameters
| Naam | Type | Beschrijving |
|---|---|---|
| status | string | Filtert pagina's op status (Voltooid, Mislukt). |
| sortBy | String | Specificeert de kolom om op te sorteren (titel, url). Standaardwaarde is titel |
| order | String | Specificeert de sorteerrichting (asc of desc). Standaardwaarde is desc. |
| createdAfter | String | Filteren op pagina's gescand na een bepaalde datum. |
| createdBefore | String | Filteren op pagina's gescand voor een bepaalde datum. |
| testUrl | String | Filteren op bepaalde geteste pagina's. |
Voorbeeldantwoord
{
"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"
]
}
]
}
Opmerking: Wanneer de instelling Tekst Vinden geactiveerd is voor de scan, bevat de array alle zinnen uit de instelling „Tekst Vinden“ die op die pagina zijn geïdentificeerd.
Probleemdetails voor een pagina
Voorbeeldverzoek
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>Vereiste parameters
| Naam | Type | Beschrijving |
|---|---|---|
| scanId | Integer | De unieke identificatie van de scan. |
| runNumber | Integer | Het specifieke uitvoeringsnummer van de scan. |
| pageId | Integer | De unieke identificatie van de pagina. |
Optionele parameters
| Naam | Type | Beschrijving |
|---|---|---|
| status | string | Filtert problemen op status (open, opgelost, of genegeerd). |
| sortBy | String | Specificeert de kolom om op te sorteren (testPageTitle, testUrl, selector, createdAt, impact, of status). Standaardwaarde is testPageTitle. |
| order | String | Specificeert de sorteerrichting (asc of desc). Standaardwaarde is desc. |
| createdAfter | String | Filteren op problemen gevonden na een bepaalde datum. |
| createdBefore | String | Filteren op problemen gevonden voor een bepaalde datum. |
Voorbeeldantwoord
{
"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"
}
]
}Probleemdetails voor een scanuitvoering
Voorbeeldverzoek
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>Vereiste parameters
| Naam | Type | Beschrijving |
|---|---|---|
| scanId | Integer | De unieke identificatie van de scan. |
| runNumber | Integer | Het specifieke uitvoeringsnummer van de scan. |
Optionele verzoekparameters
| Naam | Type | Beschrijving |
|---|---|---|
| status | string | Filtert problemen op status (open, opgelost, of genegeerd). |
| sortBy | String | Specificeert de kolom om op te sorteren (testPageTitle, testUrl, selector, createdAt, of status). Standaardwaarde is testPageTitle. |
| order | String | Specificeert de sorteerrichting (asc of desc). Standaardwaarde is desc. |
| pageId | String | Filteren op de unieke identificatie van de pagina. |
| createdAfter | String | Filteren op problemen gevonden na een bepaalde datum. |
| createdBefore | String | Filteren op problemen gevonden voor een bepaalde datum. |
| testUrl | String | Filteren op bepaalde geteste pagina's. |
| ruleId | String | Filteren op bepaalde regel-ID's. |
Voorbeeldantwoord
{
"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"
}
]
}Fouten
| HTTP-Statuscode | Fouttype | Beschrijving |
|---|---|---|
| 401 | Niet gemachtigd | De gebruiker is niet geauthenticeerd of mist toegangsrechten. |
| 400 | Ongeldige aanvraag | De aanvraag bevat ongeldige parameters. |
| 500 | Interne serverfout | Er is een fout opgetreden bij het verwerken van de aanvraag. |
Haal Axe-versies eindpunt op
Voorbeeldverzoek
GET
GET /v1/axe-versions Vereiste parameters
| Naam | Type | Beschrijving |
|---|---|---|
| scanId | Integer | De unieke identificatie van de scan. |
| runNumber | Integer | Het specifieke uitvoeringsnummer van de scan. |
| pageId | Integer | De unieke identificatie van de pagina. |
Optionele verzoekparameters
| Naam | Type | Vereist | Beschrijving |
|---|---|---|---|
| status | string | Nee | Filtert problemen op status (open, opgelost, of genegeerd). |
| sortBy | String | Nee | Specificeert de kolom om op te sorteren (testPageTitle, testUrl, selector, createdAt, of status). Standaardwaarde is testPageTitle. |
| order | String | Nee | Specificeert de sorteerrichting (asc of desc). Standaardwaarde is desc. |
Antwoordschema
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};Voorbeeldantwoord
{
"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"
}