HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference
Start typing to search…

Deprecated - Retrieve statistics of specific campaign instances.

get https://{tenanturl}/v1.0/self/instances/stats

The api to get statistics of specific campaign instances v1.0 (v1.0/self/instances/stats) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: GET /v2.0/instances/stats
Get aggregated statistics about campaign instances depending on the specified filter. If called by a user manager, the API returns statistics of instances, for which the manager has 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

state
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 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)

Responses

500

Server error

Updated about 1 month ago

Did this page help you?
Language
URL
Choose an example:
application/json

Updated about 1 month ago

Did this page help you?