Ottenere Risultati dall'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
Gli utenti di Axe Monitor possono generare una chiave API in Axe Account e recuperare i risultati delle scansioni per utilizzarli in un altro sistema.
Scopri di più su Iniziare.
Endpoint
Tutti gli endpoint possono recuperare informazioni con richieste GET.
| Endpoint | Scopo |
|---|---|
/scans |
Elenca tutte le scansioni a cui un utente può accedere. Ti consente di recuperare scanId. |
/scans/[scanId]/runs |
Elenca tutte le esecuzioni di scansione per una scansione, con informazioni di panoramica della scansione. Ti consente di recuperare il runId. |
/scans/[scanId]/runs/[runId]/pages |
Informazioni dettagliate sulla pagina per un'esecuzione di scansione. |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
Problemi di accessibilità dettagliati per una pagina. |
/scans/[scanId]/runs/[runId]/issues |
Problemi di accessibilità dettagliati per un'esecuzione di scansione. |
Elenca le scansioni per un utente
Richiesta di esempio
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>Risposta di esempio
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}Nota: Il valore ‘bozza’ si riferisce al fatto che una scansione sia stata creata come bozza assistita da IA con il Integrazione Axe Monitor MCP. Non può essere modificata dall'API.
Esecuzioni di scansione per una scansione
Richiesta di esempio
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Richiesta di esempio
Parametri Richiesti
| Nome | Tipo | Descrizione |
|---|---|---|
| scanId | Integer | L'identificatore unico della scansione. |
Parametri Opzionali
| Nome | Tipo | Descrizione |
|---|---|---|
| needsReview | Stringa | “true” o “false” ti consente di controllare se i problemi “Needs review” sono conteggiati nella risposta. |
Risposta di esempio
{
"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 la tua scansione ha una o più frasi inserite nell'impostazione “Trova testo”, la risposta API include un array findText.
Ogni voce contiene:
- La frase inserita.
- Il numero di pagine in cui la frase è stata identificata.
Dettagli della pagina per un'esecuzione di scansione
Richiesta di esempio
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>Parametri del percorso richiesti
| Nome | Tipo | Descrizione |
|---|---|---|
| scanId | Integer | L'identificatore unico della scansione. |
| runNumber | Integer | Il numero specifico dell'esecuzione della scansione. |
Parametri Opzionali della Richiesta
| Nome | Tipo | Descrizione |
|---|---|---|
| status | stringa | Filtra le pagine per stato (Completato, Fallito). |
| sortBy | Stringa | Specifica la colonna per ordinare (titolo, url). Il valore predefinito è titolo. |
| order | Stringa | Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc. |
| createdAfter | Stringa | Filtra per pagine scansionate dopo una certa data. |
| createdBefore | Stringa | Filtra per pagine scansionate prima di una certa data. |
| testUrl | Stringa | Filtra per determinate pagine testate. |
Risposta di esempio
{
"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 l'impostazione Trova Testo è abilitata per la scansione, l'array contiene tutte le frasi dall'impostazione „Trova Testo“ che sono state identificate su quella pagina.
Dettagli sui Problemi per una Pagina
Richiesta di esempio
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>Parametri Richiesti
| Nome | Tipo | Descrizione |
|---|---|---|
| scanId | Integer | L'identificatore unico della scansione. |
| runNumber | Integer | Il numero specifico dell'esecuzione della scansione. |
| pageId | Integer | L'identificatore univoco della pagina. |
Parametri Opzionali
| Nome | Tipo | Descrizione |
|---|---|---|
| status | stringa | Filtra i problemi per stato (aperti, risolti o ignorati). |
| sortBy | Stringa | Specifica la colonna per ordinare (testPageTitle, testUrl, selector, createdAt, impact, o status). Il valore predefinito è testPageTitle. |
| order | Stringa | Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc. |
| createdAfter | Stringa | Filtra per problemi trovati dopo una certa data. |
| createdBefore | Stringa | Filtra per problemi trovati prima di una certa data. |
Risposta di esempio
{
"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"
}
]
}Dettagli sui Problemi per un Eseguito di Scansione
Richiesta di esempio
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>Parametri Richiesti
| Nome | Tipo | Descrizione |
|---|---|---|
| scanId | Integer | L'identificatore unico della scansione. |
| runNumber | Integer | Il numero specifico dell'esecuzione della scansione. |
Parametri Opzionali della Richiesta
| Nome | Tipo | Descrizione |
|---|---|---|
| status | stringa | Filtra i problemi per stato (aperti, risolti o ignorati). |
| sortBy | Stringa | Specifica la colonna per ordinare (testPageTitle, testUrl, selector, createdAt, o status). Il valore predefinito è testPageTitle. |
| order | Stringa | Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc. |
| pageId | Stringa | Filtra per l'identificatore univoco della pagina. |
| createdAfter | Stringa | Filtra per problemi trovati dopo una certa data. |
| createdBefore | Stringa | Filtra per problemi trovati prima di una certa data. |
| testUrl | Stringa | Filtra per determinate pagine testate. |
| ruleId | Stringa | Filtra per determinati ID delle regole. |
Risposta di esempio
{
"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"
}
]
}Errori
| Codice di Stato HTTP | Tipo di Errore | Descrizione |
|---|---|---|
| 401 | Non autorizzato | L'utente non è autenticato o non ha i diritti di accesso. |
| 400 | RichiestaNonValida | La richiesta contiene parametri non validi. |
| 500 | Errore Interno del Server | Si è verificato un errore durante l'elaborazione della richiesta. |
Endpoint delle Versioni di Axe
Richiesta di esempio
GET
GET /v1/axe-versions Parametri Richiesti
| Nome | Tipo | Descrizione |
|---|---|---|
| scanId | Integer | L'identificatore unico della scansione. |
| runNumber | Integer | Il numero specifico dell'esecuzione della scansione. |
| pageId | Integer | L'identificatore univoco della pagina. |
Parametri Opzionali della Richiesta
| Nome | Tipo | Richiesto | Descrizione |
|---|---|---|---|
| status | stringa | No | Filtra i problemi per stato (aperti, risolti o ignorati). |
| sortBy | Stringa | No | Specifica la colonna per ordinare (testPageTitle, testUrl, selector, createdAt, o status). Il valore predefinito è testPageTitle. |
| order | Stringa | No | Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc. |
Schema di Risposta
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};Risposta di esempio
{
"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"
}