HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

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
API request is only valid for resources created using V1 version. Attempting to access V2-exclusive resources with the V1 API will result in a 400 error. Additionally, V2 resources are excluded from V1 API filter search results.
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].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

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: 'all', '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: 'all', 'active', 'inactive'.

boolean

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

string
Defaults to assigned

Filter campaign instances based on the source: 'all', '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 8 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated 8 months ago