プロジェクト API リファレンス

Projects エンドポイントは、API キーでアクセスできる Axe Developer Hub プロジェクトのリストを返します。プロジェクトの名前からその ID を見つけ出し、その ID をセッションと結果 APIに渡すことができます。

すでにプロジェクト ID が分かっている場合は、Axe Developer Hubで見つけて、セッションと結果 API を直接呼び出すことができます。このエンドポイントは必要ありません。

認証

すべてのリクエストには API キーが必要です。X-API-Key ヘッダーを使用して提供してください:

X-API-Key: <DEQUE_API_KEY>

Axe アカウントポータル で API キーを見つけてください。Web または CI/CD プロジェクト用の Axe Developer Hub API キー、またはモバイルプロジェクト用の Axe DevTools Mobile API キーを選択します。

アクセス制御

• プロジェクトメンバー は、所属しているプロジェクトのみを参照できます。
• 組織管理者 は、Axe Developer Hub または Axe DevTools Mobile サブスクリプションが有効である限り、そのプロダクトタイプの組織内のすべてのプロジェクトを、プロジェクトメンバーシップに関係なく参照できます。
• どちらの場合も、レスポンスは API キーのプロダクトにスコープされます: Axe Developer Hub API キーは Axe Developer Hub プロジェクトのみを返し、Axe DevTools Mobile API キーは Axe DevTools Mobile プロジェクトのみを返します。

非アクティブなサブスクリプション が401 Unauthorizedを返します。

プロジェクトエンドポイント

認証された API キーでアクセス可能なプロジェクトのリストを返します。

リクエスト

• エンドポイント: GET https://axe.deque.com/api-pub/v1/results/projects
• ヘッダー（必須）:
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

クエリパラメータ

すべてのクエリパラメータは任意です。

レスポンスボディ

成功したレスポンスは、プロジェクトオブジェクトの JSON 配列を返します。各プロジェクトオブジェクトには、以下のフィールドが含まれます。

例の応答ボディ

[
  {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "role": "admin",
    "created_at": "2026-06-01T14:23:00.000Z",
    "last_session_created_at": "2026-06-14T09:12:00.000Z",
    "has_git_information": true,
    "git_url": "https://github.com/example/webapp",
    "latest_session": {
      "session_id": "0d4a85a2-9e6f-44ef-b814-fee8412abeb0",
      "created_at": "2026-06-14T09:12:00.000Z",
      "git_branch": "main"
    }
  },
  {
    "project_id": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
    "name": "design-system",
    "selected_project_type": "axe-devtools-html",
    "role": "admin",
    "created_at": "2026-05-20T08:00:00.000Z",
    "last_session_created_at": null,
    "has_git_information": false,
    "git_url": null,
    "latest_session": null
  }
]

カーソルページネーション

ページネーションは任意です。page_sizeまたはafterが送信されないリクエストは、カーソルヘッダーなしで全プロジェクトリストを単一のレスポンスで返します。まるでこれらのパラメータが存在しないかのように。

代わりに結果をページをめくる場合は、セッションエンドポイントと同じカーソルベースのページネーションをプロジェクトエンドポイントが使用します。現在のページを超える結果がある場合、不透明なカーソル値がx-pagination-cursorのレスポンスヘッダーに返されます。この値を次のリクエストでafterクエリパラメータとして渡して次のページを取得します。

レスポンスにx-pagination-cursorヘッダーが存在しない場合、最後のページに達したということです。

プロジェクトIDを名前で検索する

この例では、curlとjqを使用してプロジェクトのIDを名前から見つけます。

curl -s \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  "https://axe.deque.com/api-pub/v1/results/projects" \
  | jq -r '.[] | select(.name == "webapp-ci") | .project_id'

そのプロジェクトのセッションを一覧表示するために、返されたIDをセッションエンドポイントに渡します。

プロジェクトエンドポイントのエラーレスポンス