Retrieves the campaign instance statistics from the specific tenant.

The API is used to retrieve the campaign instance statistics from the specific tenant.
Unspecified filter parameters are treated as having the default values.
Every provided parameter value is considered as an extra filter for the search criteria.
If called by an application owner, the API returns statistics of the instances that the owner created or contains at least one application that the owner owns.
If called by user manager, the API returns statistics of instances, for which there is at least one item to review.
Entitlements required: manageAccessCertification [Manage Access Certification].

Query Params
string
Defaults to all

The filter type to apply: createdby, type, reviewer, state, priority, application

array of strings
Defaults to all

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

Multiple values can be selected.

state
string
Defaults to all

The filter for the overall state of the campaign instance: active, inactive

boolean

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

string
Defaults to assigned

Filter by how the campaigns have been assigned to the calling user: assigned, delegated.

string

The generic filter for returning campaigns that contains the passed string in one of the following attributes: name (Campaign instance name)

Headers
boolean
required

If the value is set to true, the API call is treated as an admin API call.

Responses

500

Your request cannot be processed because an internal server error occurred.

Language
URL
Choose an example:
application/json