Using the API

Audit Listing and Test Result Retrieval (with Basic Auth)

For complete and detailed documentation of the Asqatasun API, please refer to the official Swagger interface available on your deployed instance of asqatasun-server at the following path:

/swagger-ui/index.html

Authentication

All endpoints require authentication via Basic Auth.

Use the -u option to set your credentials in each request

List all audits for the current authenticated user

Endpoint

GET /api/v0/audit/

Description

Returns the list of all audits performed by the currently authenticated user.

Request Example (with curl)

curl -u your_username:your_password -H "Accept: application/json" 
https://asqatasun_instance_server_url/api/v0/audit/

Response Example

[
    {
        "id": 42,
        "subject":{
            "id":51,
            "type":"PAGE",
            "url":"https://mywebsite.fr/",
            "nbOfPages":1,
            "grade":"C",
            "mark":88.89,
            "nbOfFailureOccurrences":1,
            "repartitionBySolutionType":
            [
              {"type":"PASSED","number":8},
              {"type":"FAILED","number":1},
              {"type":"NEED_MORE_INFO","number":67},
              {"type":"NOT_APPLICABLE","number":41},
              {"type":"NOT_TESTED","number":140}
            ]
        },
        "status":"COMPLETED",
        "date":"2025-06-10T12:30:27.000+00:00",
        "tags":[],
        "referential":"RGAA_4_2_1",
        "referentialLevel":"LEVEL_2"
    },
  {
    "id": 43,
    "subject":{
      "id":59,
      "type":"PAGE",
      "url":"https://another_mywebsite.fr/",
      "nbOfPages":1,
      "grade":"F",
      "mark":51.89,
      "nbOfFailureOccurrences":21,
      "repartitionBySolutionType":
      [
        {"type":"PASSED","number":6},
        {"type":"FAILED","number":4},
        {"type":"NEED_MORE_INFO","number":67},
        {"type":"NOT_APPLICABLE","number":41},
        {"type":"NOT_TESTED","number":140}
      ]
    },
    "status":"COMPLETED",
    "date":"2025-08-26T12:30:27.000+00:00",
    "tags":[],
    "referential":"RGAA_4_2_1",
    "referentialLevel":"LEVEL_2"
  }
]

Get test results for a specific audit

Endpoint for specific audit

GET /api/v0/audit/{auditId}/tests

Description for specific audit

Retrieve all test results associated with a specific audit ID.

Path Parameters

Parameter	Type	Description
`auditId`	long	The ID of the audit

Request Example

curl -u your_username:your_password \
-H "Accept: application/json" \
https://asqatasun_instance_server_url/api/v0/audit/42

Response Example for specific audit

{
  "id": 62,
  "subject":{
    "id": 83,
    "type":"PAGE",
    "url":"https://unique_mywebsite.fr/",
    "nbOfPages":1,
    "grade":"F",
    "mark":51.89,
    "nbOfFailureOccurrences":21,
    "repartitionBySolutionType":
    [
      {"type":"PASSED","number":6},
      {"type":"FAILED","number":4},
      {"type":"NEED_MORE_INFO","number":67},
      {"type":"NOT_APPLICABLE","number":41},
      {"type":"NOT_TESTED","number":140}
    ]
  },
  "status":"COMPLETED",
  "date":"2025-08-26T12:30:27.000+00:00",
  "tags":[],
  "referential":"RGAA_4_2_1",
  "referentialLevel":"LEVEL_2"
}

Notes

Make sure your user account has access to the audit data.

Only audits run by the authenticated user will be listed.

Documenting