Appearance
Get campaign runs.
GET
/backend/v1/campaign-runs
Retrieves a list of campaign runs that match the given criteria,
with the option to adjust the limit for more results.
Authorizations
HTTPBearer
TypeHTTP (bearer)
Parameters
Query Parameters
cursor
Selects page for paginated results. Pass in the next or prev attribute in the response
search
Only return results that match the given text.
limit
Limits the amount of results.
Typeinteger
default
10maximum
100minimum
1ascending
Whether results should be sorted in ascending order.
Typeboolean
default
falsecampaignScheduleId
Filter by campaign runs in this schedule
status
Filter by campaign runs with any of these statuses
includeProviders
Include providers that the campaign was run against
Typeboolean
default
falseincludeCampaigns
Include campaigns
Typeboolean
default
trueincludeSchedules
Include campaign schedules
Typeboolean
default
falsesortBy
Sort results by the given parameter.
Typestring
Enum
namecreated_atstart_atResponses
Successful Response
application/json
JSON
{
"campaignRuns": [
{
"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"
}
],
"campaigns": {
"additionalProperties": {
}
},
"next": "string",
"prev": "string",
"providers": {
"additionalProperties": {
}
},
"schedules": {
"additionalProperties": {
}
}
}