Deprecated - Retrieve campaign instances.

The api to get campaign instances v1.0 (v1.0/self/instances) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: GET /v2.0/instances
Get campaign instances with at least one record associated with a reviewer or supervisor.
Entitlements required: manageAccessCertification [Manage Access Certification].

Query Params
string
Defaults to all

The filter for the campaign instance type: userassignment, groupassignment, or account.

array of strings
Defaults to all

The filter for the campaign instance state: noinstance, aborted, closed, completed, created, deleted, failed, paused, running, starting, success.

Multiple values can be selected.

state
string
Defaults to all

The filter for the campaign instance priority: high, medium, or low.

string
Defaults to all

The filter for getting preview campaign instances: yes, no.

string
Defaults to all

The filter for getting continuous campaign instances: yes, no.

array of strings

The filter for the campaign owner.

Provide multiple values in new lines or separated by commas. For example, 607000JX53, 6050001F7Z, 50EEPX4TQC

ownersId
array of strings

The filter for the campaign application.

Provide multiple values in new lines or separated by commas. For example,7728662622850583652, 7729580475382480456

appsId
string
Defaults to all

To filter based on the overall state of the campaign instance. This filter is to logically 'group' the possible campaign instance states: active,inactive.

boolean

Consider the calling user as a supervisor of the campaign when set to true.

string
Defaults to assigned

Filter by which the campaigns were assigned to the calling user: assigned, delegated.

string
Defaults to no

Filter for including aggregated data (that is, statistics, progress) to the instance objects: dataonly, yes, or no.

string

The generic filter for returning campaign instances that contain the passed string in one of the following attributes: name (Campaign instance name).

string

The attribute of the campaign instance that is used to sort results. The possible values are: name, type, priority, status, timelaststart, timeclosed, progress, lastpausedate, timeremaining.


When you provide,
name: The campaign instance name is used for sorting.
type: The campaign instance type is used for sorting.
priority: The campaign instance priority is used for sorting.
status: The campaign instance status is used for sorting.
timelaststart: The campaign instance lastStartDate timestamp is used for sorting.
timeclosed: The campaign instance endDate timestamp is used for sorting.
progress: The campaign instance progress is used for sorting.
lastpausedate: The campaign instance lastPauseDate timestamp is used for sorting.
timeremaining: The campaign instance timeRemaining timestamp is used for sorting.

boolean
Defaults to true

Decides sort order.

string
Defaults to 500

Specifies the maximum number of resources that the search returns for a page.

string
Defaults to 1

Page number.

Responses

500

Server error

Language
URL
Choose an example:
application/json