Search K
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
Type
HTTP (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.
Type
integer
Default
10Maximum
100Minimum
1ascending
Whether results should be sorted in ascending order.
Type
boolean
Default
falsebefore
Only return results from before this timestamp.
after
Only return results from after this timestamp.
name
Filter by campaign runs with names that match this value.
campaignScheduleId
Filter by campaign runs in this schedule.
status
Filter by campaign runs with any of these statuses.
providerId
Filter by provider that the campaign was run against.
createdBy
Filter by users that created the campaign runs.
scoreRange
Only return campaign runs with a score between range.
includeProviders
Include providers that the campaign was run against.
Type
boolean
Default
falseincludeRemediations
Include remediations that were created from the campaign runs.
Type
boolean
Default
falseincludeCampaigns
Include campaigns.
Type
boolean
Default
falseincludeSchedules
Include campaign schedules.
Type
boolean
Default
falseincludeUsers
Include users.
Type
boolean
Default
falsesortBy
Sort results by the given parameter.
Default
"created_at"preserve
Filter by campaign runs that are preserved or not.
vendored
Filter by campaign runs that are vendored or not.
Type
boolean
Default
falseResponses
Successful Response
application/json
JSON
"string"