Simulation
Team simulation

Get campaigns statistics

Retrieves statistics about campaigns in a workspace including attack events counts. Description of the events can be found at https://docs.tryriot.com/api-reference/simulation/list-attacks#response-type

Scopes required:

  • simulation:read
get/v1/campaigns/statistics

Request

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

Query parameters

workspace_idstring uuid required

ID of the workspace for which to retrieve campaign statistics

campaign_idstring uuid

ID of the campaign for which to retrieve statistics

campaign_cycle_idstring uuid

ID of the campaign cycle for which to retrieve statistics

created_afterstring date-time

Optional parameter to filter statistics for attacks created after specified date

created_beforestring date-time

Optional parameter to filter statistics for attacks created before specified date

Response

Campaign statistics

Changes

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