Get Test Results

This guide is designed for new users who want to retrieve test execution results, known as test summaries. You can get the planRunId directly from running tests or by listing past summaries.

✅ Step 1: List Test Summaries

Why this matters: You need the planRunId to query a specific test result.

List all test summaries
Use the following endpoint:
GET /api/data/v1/accounts/:accountId/testsummaries

Optional filters:

• planId – to filter by a specific scenario
• status – to narrow by test state
• sortBy=endTime – to get the latest runs

Example:

GET /api/data/v1/accounts/12345/testsummaries?size=100&sortBy=endTime

Sample Response:

[
  {
    "planRunId": "67890",
    "planId": "abcde",
    "startTime": "2024-01-15T12:00:00Z",
    "endTime": "2024-01-15T12:10:00Z",
    "status": "Completed",
    "blocked": 24,
    "notBlocked": 6,
    "assumedBlocked": 1
  }
]

What to look for:
Copy the relevant planRunId from the response to use in the next step.

✅ Step 2: Retrieve a Specific Test Summary

Why this matters: This gives you full details on test execution, including blocked attacks and simulator behavior.

Get test summary by planRunId
Use this endpoint:
GET /api/data/v1/accounts/:accountId/testsummaries/:planRunId

Example:

GET /api/data/v1/accounts/12345/testsummaries/67890

Sample Response:

{
  "planRunId": "67890",
  "planName": "Lateral Movement Test",
  "startTime": "2024-01-15T12:00:00Z",
  "endTime": "2024-01-15T12:10:00Z",
  "blocked": 24,
  "notBlocked": 6,
  "assumedBlocked": 1,
  "simulators": [
    {
      "simulatorId": "sim-001",
      "name": "HQ-Simulator"
    }
  ],
  "matrixId": "matrix-abc",
  "simulationId": "sim-run-567"
}

What you get:

• Blocked / not blocked / assumed blocked counts
• Start and end times
• Simulator involvement
• Matrix and simulation IDs.

✅ Optional: Retrieve Multiple Test Summaries at Once

Use case: Bulk analysis or correlation across several test executions.

Endpoint:
GET /api/data/v1/accounts/:accountId/detailedTestSummaries?planRunIds=id1|id2|id3

Example:

GET /api/data/v1/accounts/12345/detailedTestSummaries?planRunIds=67890|12345|23456

Sample Response:

[
  {
    "planRunId": "67890",
    "planName": "Lateral Movement Test",
    "blocked": 24,
    "notBlocked": 6
  },
  {
    "planRunId": "12345",
    "planName": "Phishing Simulation",
    "blocked": 12,
    "notBlocked": 8
  }
]

📝 Best Practice Tips

• Sort summaries by endTime to identify the most recent test.
• Save commonly used planRunIds for faster future access.
• Use metadata tagging or descriptions in your test plans for easier identification.