HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Deprecated - Retrieve statistics of specific campaign instances.

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

The api to get statistics of specific campaign instances v1.0 (v1.0/admin/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 an application owner, the API returns statistics of the instances that the owner created or that contain at least one application that the owner owns.
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: 'all', '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'.

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 9 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated 9 months ago