Simulation
Team simulation

List attacks

Retrieves a list of attacks of a campaign with associated events, sorted by their creation date in descending order (most recent entries first).

Scopes required:

  • simulation:read
get/v1/campaigns/{campaign_id}/attacks

Request

  • Base URL: https://public-api.tryriot.com
  • URL: https://public-api.tryriot.com/v1/campaigns/{campaign_id}/attacks
  • Auth: API key in header x-api-key

Path parameters

campaign_idstring uuid required

Campaign id for which to get the attacks

Query parameters

cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

limitinteger

Maximum number of items to return. Maximum value is 100.

workspace_idstring uuid required

Workspace id for which to get the attacks

campaign_cycle_idstring uuid

Id of the cycle the attack belongs to

created_afterstring date-time

Filters attacks based on their creation date. Only attacks created after specified date (UTC) will be included in the response.

created_beforestring date-time

Filters attacks based on their creation date. Only attacks created before specified date (UTC) will be included in the response.

is_trickedboolean

Filters attacks based on whether the employee was tricked.

  • true: Returns attacks where the employee was tricked.
  • false: Returns attacks where the employee was not tricked.

Headers

x-item-limitinteger

Maximum number of items to return. Maximum value is 100.

x-next-cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Response

Attacks list

Example response

{
  "data": [
    {
      "employee": {
        "name": "John Doe",
        "primary_email_address": "john.doe@tryriot.com"
      },
      "events": [
        {
          "created_at": "2025-03-06T14:18:18.397000Z",
          "data": null,
          "id": "f28a3b79-1c54-4ef5-a1db-7c48e2d9c4a2",
          "type": "remedial_started"
        },
        {
          "created_at": "2025-03-06T14:18:07.996000Z",
          "data": null,
          "id": "b9c2e7d1-5f3a-42d8-b0e5-9a6d481c7f52",
          "type": "employee_tricked"
        },
        {
          "created_at": "2025-03-06T14:18:07.989000Z",
          "data": {
            "password_length": 12,
            "score": 4
          },
          "id": "7d5e8f2a-9b34-4c01-a6d7-1e3f8b952c9a",
          "type": "credentials_submitted"
        },
        {
          "created_at": "2025-03-06T14:17:54.181000Z",
          "data": null,
          "id": "2c4d6e8f-a3b5-4c7d-9e1f-0a2b4c6d8e0f",
          "type": "page_opened"
        },
        {
          "created_at": "2025-03-06T14:16:58.163000Z",
          "data": null,
          "id": "5a1b3c7d-9e2f-4a6b-8c0d-2e4f6a8b0c2d",
          "type": "email_opened"
        },
        {
          "created_at": "2025-03-06T14:16:38.716655Z",
          "data": null,
          "id": "1d3f5e7a-9b2c-4d6e-8f0a-2c4d6e8a0c2e",
          "type": "attack_sent"
        }
      ],
      "sender": {
        "email": "marketing@noreply.link",
        "name": "Marketing team"
      },
      "service": {
        "name": "Microsoft"
      },
      "template": {
        "name": "security-issue-detected"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.