Search K
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
Type
HTTP (bearer)
Parameters
Path Parameters
campaignRunId*
Type
Requiredstring
Format
"uuid"Query Parameters
includeResults
Include attack results in response. Deprecated, use GET /campaign-runs/{id}/results
Type
boolean
Default
falseincludeProviders
Include providers that the campaign was run against
Type
boolean
Default
falseincludeSchedule
Include the campaign run's schedule if it has one
Type
boolean
Default
falseincludeCampaign
Include the campaign run's campaign
Type
boolean
Default
falseResponses
Successful Response
application/json
JSON "campaign": { "attacks": [ { { "fileId": "string", "name": "string", "severity": 1, "technique": "custom" } } ], "createdAt": "string", "createdBy": "string", "description": "string", "id": "string", "lastRun": "string", "lastRunAt": "string", "name": "string", "runCount": 0, "vendored": false }, "campaignRun": { "CASIScore": 0, "actionsCount": 0, "attackRuns": [ { "attack": { "converters": [ [ "base64", "leetspeak", "unicode_confusable", "caesar", "repeat_token", "single_character" ] ], "pack": "2026-11", "severity": 1, "technique": "static_content", "vector": "string" }, "errorCount": 0, "events": [ { "createdAt": "string", "event": "queued" } ], "id": "string", "progress": 0, "providerId": "string", "providerName": "string", "results": [ { "conversation": [ { "additionalProperties": "string" } ], "conversationSteps": 0, "converter": "string", "error": "string", "errorSummary": { "message": "string", "type": "string" }, "intent": "string", "intentCategory": "string", "intentType": "string", "refusalCheck": { "isDeterministic": false, "isRefusal": false, "matchedPhrases": [ [ ] ], "score": 0, "sources": [ [ ] ] }, "severity": 0, "vulnerable": true } ], "total": 0 } ], "averagePerformance": 0, "campaignId": "string", "casiScorePositionDelta": 0, "completedAt": "string", "costOfSecurity": 0, "createdAt": "string", "createdBy": "string", "id": "string", "name": "string", "preserve": false, "progress": 0, "projectAccess": { "global": false, "projectIds": [ "string" ] }, "providerErrors": { "additionalProperties": { "errorCount": 0, "providerFailed": true, "providerName": "string", "totalPrompts": 0 } }, "purged": false, "remediation": { "available": false, "id": "string" }, "remediationSettings": { "autorun": false }, "retries": 0, "retryable": false, "rtpRatio": 0, "runTime": 0, "scheduleId": "string", "startAt": "string", "status": "string", "total": 0, "vendored": false }, "providers": { "additionalProperties": { "authTemplate": null, "availability": { "global": false, "projectIds": [ [ ] ] }, "capabilities": [ "string" ], "hasLogo": false, "id": "string", "inputs": { "additionalProperties": "string" }, "maxRequestsPerSecond": 0, "name": "string", "projectId": "string", "redTeam": false, "requestConcurrencyLimit": { "decayPerSecond": 0, "requests": 0 }, "secrets": { "additionalProperties": "string" }, "siem": false, "systemProviderId": "string", "tag": "string", "template": { "awsAuth": { "accessKey": "string", "region": "string", "secretKey": "string", "service": "string", "token": "string" }, "body": "string", "headers": { "additionalProperties": "string" }, "json": "string", "method": "string", "ociAuth": { "keyId": "string", "passphrase": "string", "privateKeyPem": "string" }, "outputs": { }, "queryParams": { "additionalProperties": "string" }, "timeout": 20, "type": "request", "url": "string" }, "type": "string" } }, "schedule": { "campaignId": "string", "count": 0, "createdAt": "string", "endAt": "string", "error": "string", "frequency": "string", "id": "string", "interval": 0, "name": "string", "providerIds": [ "string" ], "remediationSettings": { "autorun": false }, "startAt": "string" }
{
}