Query statistics

get

https://{tenant}/admin/api/v1/statistics/{name}

You can query statistics by calling this endpoint.

REQUIRED API PERMISSION
read:statistic

Path Params

name

string

enum

required

Query Params

startDate

date-time

endDate

date-time

location

string

Defaults to Etc/UTC

Location in IANA time zone format.

groupBy

array of strings

groupBy

application

array of strings

List of application ids that events should be used for the statistics

application

client

array of strings

List of client ids that events should be used for the statistics

client

identityStores

array of strings

Filter by identity store names

identityStores

hook

array of strings

Filter by hook id or ids. Supported for 'EventHookExecutionTime' and 'EventHookErrors', otherwise ignored.

hook

organization

array of strings

Filter by organization id or ids

organization

interval

string

enum

Allowed:

period

string

enum

Desired resolution for the the requested statistics

Allowed:

flowType

array of strings

enum

Filter against the given flowType. Supported for 'FlowRun', otherwise ignored.

flowType

decision

array of strings

enum

Filter against adaptive access decision. Supported for 'AdaptiveAccess', otherwise ignored.

decision

result

array of strings

enum

Filter against the given result.

result

variant

array of strings

Filter against the given variant IDs or 'null'. Explicit 'null' means baseline variant.

variant

size

int32

≥ 0

Defaults to 0

Limits the number of returned elements. Value '0' means no limiting. Supported for 'FlowRun' and 'ScreenTime', otherwise ignored.

sort

string

Sorting criteria in the format: value,(asc|desc). Supported for 'FlowRun' and 'ScreenTime', otherwise ignored.

consentId

string

Consent ID filter. Supported for 'ConsentActivity', otherwise ignored.

consentVersion

int32

Consent version filter, which should be used with consent ID. Supported for 'ConsentActivity', otherwise ignored.

connectorResponseTimeType

array of strings

Filter against the given connector response time type. Supported for 'ConnectorResponseTime', otherwise ignored.

connectorResponseTimeType

connectorErrorType

array of strings

Filter against the given connector error type. Supported for 'ConnectorError', otherwise ignored.

connectorErrorType

stepId

array of strings

Filter against identity verification step id. supported for 'IdentityVerificationStep', otherwise ignored.

stepId

policyId

string

Identity verification policy ID filter. supported for 'IdentityVerificationStep', otherwise ignored.

policyVersion

string

Identity verification policy version filter. Should be used with identity verification policy ID. Supported for 'IdentityVerificationStep', otherwise ignored.

Headers

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden