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のユーザーは、Axe AccountでAPIキーを生成し、別のシステムで使用するためにスキャン結果を取得できます。
開始するについて詳しく学ぶ。
エンドポイント
すべてのエンドポイントはGETリクエストで情報を取得できます。
| エンドポイント | 目的 |
|---|---|
/scans |
ユーザーがアクセスできるすべてのスキャンを一覧表示します。これにより、scanId.を取得できます |
/scans/[scanId]/runs |
スキャンのすべてのスキャン実行を、スキャン概要情報とともに一覧表示します。これにより、runId.を取得できます |
/scans/[scanId]/runs/[runId]/pages |
スキャン実行の詳細なページ情報。 |
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues |
ページの詳細なアクセシビリティの問題。 |
/scans/[scanId]/runs/[runId]/issues |
スキャン実行の詳細なアクセシビリティの問題。 |
ユーザーのスキャン一覧
リクエストの例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>レスポンスの例
{
"scans": [
"id": 0,
"name": ""string",
"draft": true,
"groups": [
"id": 0,
"name": "string"
]
]
}注意：「ドラフト」の値は、Axe Monitor MCPインテグレーションを使用してAI支援のドラフトとしてスキャンが作成されたかどうかを示します。APIでは編集できません。
スキャンのスキャン実行
リクエストの例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>リクエストの例
必須パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| scanId | 整数 | スキャンの一意識別子。 |
オプションパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| needsReview | 文字列 | “true” または “false” により、「レビューが必要」な問題がレスポンスでカウントされるかどうかを制御します。 |
レスポンスの例
{
"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
}
]
}
]
}注意：スキャンに「テキストを検索」設定で入力されたフレーズが1つ以上ある場合、APIレスポンスにはfindText配列が含まれます。
各エントリには以下が含まれます：
- 入力されたフレーズ。
- フレーズが識別されたページの数。
スキャン実行のページ詳細
リクエストの例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
X-API-KEY: <your_api_key>必須パスパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| scanId | 整数 | スキャンの一意識別子。 |
| runNumber | 整数 | スキャンの特定の実行番号。 |
オプションリクエストパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| status | 文字列 | ステータス（完了、失敗）でページをフィルタリングします。 |
| sortBy | 文字列 | ソートする列を指定します（タイトル、URL）。デフォルト値はタイトルです |
| order | 文字列 | ソート方向を指定します（昇順または降順）。デフォルト値は降順です。 |
| createdAfter | 文字列 | ある日付以降にスキャンされたページでフィルタリングします。 |
| createdBefore | 文字列 | 特定の日付以前にスキャンされたページでフィルタします。 |
| testUrl | 文字列 | 特定のページでテストされたものをフィルタします。 |
レスポンスの例
{
"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"
]
}
]
}
注意: スキャンの際に「テキスト検索」設定が有効になっている場合、配列にはそのページで特定された「テキスト検索」設定からのすべてのフレーズが含まれます。
ページの問題の詳細
リクエストの例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>必須パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| scanId | 整数 | スキャンの一意識別子。 |
| runNumber | 整数 | スキャンの特定の実行番号。 |
| pageId | 整数 | ページの一意の識別子。 |
オプションパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| status | 文字列 | ステータス（オープン、修正済み、無視）によって問題をフィルタします。 |
| sortBy | 文字列 | ソートするカラムを指定します（testPageTitle、testUrl、selector、createdAt、impact、またはstatus）。デフォルト値はtestPageTitleです。 |
| order | 文字列 | ソート方向を指定します（昇順または降順）。デフォルト値は降順です。 |
| createdAfter | 文字列 | 特定の日付以降に発見された問題でフィルタします。 |
| createdBefore | 文字列 | 特定の日付以前に発見された問題でフィルタします。 |
レスポンスの例
{
"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"
}
]
}スキャン実行の問題の詳細
リクエストの例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>必須パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| scanId | 整数 | スキャンの一意識別子。 |
| runNumber | 整数 | スキャンの特定の実行番号。 |
オプションリクエストパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| status | 文字列 | ステータス（オープン、修正済み、無視）によって問題をフィルタします。 |
| sortBy | 文字列 | ソートするカラムを指定します（testPageTitle、testUrl、selector、createdAt、またはstatus）。デフォルト値はtestPageTitleです。 |
| order | 文字列 | ソート方向を指定します（昇順または降順）。デフォルト値は降順です。 |
| pageId | 文字列 | ページの一意の識別子でフィルタします。 |
| createdAfter | 文字列 | 特定の日付以降に発見された問題でフィルタします。 |
| createdBefore | 文字列 | 特定の日付以前に発見された問題でフィルタします。 |
| testUrl | 文字列 | 特定のページでテストされたものをフィルタします。 |
| ruleId | 文字列 | 特定のルールIDでフィルタします。 |
レスポンスの例
{
"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"
}
]
}エラー
| HTTPステータスコード | エラータイプ | 説明 |
|---|---|---|
| 401 | 認証失敗 | ユーザーは認証されていないか、アクセス権がありません。 |
| 400 | 無効なリクエスト | リクエストには無効なパラメータが含まれています。 |
| 500 | 内部サーバーエラー | リクエストの処理中にエラーが発生しました。 |
Axeのバージョンを取得するエンドポイント
リクエストの例
GET
GET /v1/axe-versions 必須パラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| scanId | 整数 | スキャンの一意識別子。 |
| runNumber | 整数 | スキャンの特定の実行番号。 |
| pageId | 整数 | ページの一意の識別子。 |
オプションリクエストパラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| status | 文字列 | いいえ | ステータス（オープン、修正済み、無視）によって問題をフィルタします。 |
| sortBy | 文字列 | いいえ | ソートするカラムを指定します（testPageTitle、testUrl、selector、createdAt、またはstatus）。デフォルト値はtestPageTitleです。 |
| order | 文字列 | いいえ | ソート方向を指定します（昇順または降順）。デフォルト値は降順です。 |
レスポンススキーマ
type AxeVersionDto = {
version: string;
supported: boolean;
tags: string[];
};
type GetAxeVersionsResponse = {
versions: AxeVersion[];
default: string;
};レスポンスの例
{
"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"
}