Appearance
Get campaign run.
GET
/backend/v1/campaign-runs/{campaignRunId}
Returns a campaign run based on its ID. Optional parameters allow including results,
providers, and schedule objects in the response.
Authorizations
HTTPBearer
TypeHTTP (bearer)
Parameters
Path Parameters
campaignRunId*
Typestring
Requiredformat
uuidQuery Parameters
includeResults
Include attack results in response
Typeboolean
default
falseincludeProviders
Include providers that the campaign was run against
Typeboolean
default
falseincludeSchedule
Include the campaign run's schedule if it has one
Typeboolean
default
falseResponses
Successful Response
application/json
JSON
{
"campaignRun": {
"CASIScore": "string",
"attackRuns": [
{
"attack": {
"converters": [
[
"base64",
"leetspeak",
"unicode_confusable",
"caesar",
"repeat_token",
"single_character"
]
],
"pack": "string",
"severity": 1,
"technique": "static_content",
"vector": "string"
},
"errorCount": 0,
"events": [
{
"createdAt": "string",
"event": "queued"
}
],
"id": "string",
"progress": 0,
"providerId": "string",
"results": [
{
"conversation": [
{
}
],
"conversationSteps": 0,
"converter": "string",
"error": "string",
"errorSummary": "string",
"fingerprint": "string",
"intent": "string",
"intentCategory": "string",
"vulnerable": true
}
],
"total": "string"
}
],
"campaignId": "string",
"createdAt": "string",
"createdBy": "string",
"id": "string",
"name": "string",
"progress": 0,
"scheduleId": "string",
"startAt": "string",
"status": "string",
"total": "string"
},
"providers": {
"additionalProperties": {
}
},
"schedule": "string"
}