PingOne Platform APIs

Authentications per Application

The authentications per application service calculates the number of successful sign-on actions for all applications in a specified environment during a specified time period. This metric shows how often applications are accessed, using authentications as the measure of the application’s usage. Organizations can use this metric to:

  • Determine which applications are responsible for the highest volume of authentication requests, in rank order.

  • Refer to which applications are rarely used and are candidates for decommission.

  • Refer to the relative number of authentication requests for each connected application.

  • Determine whether an application’s usage is growing or shrinking over time.

  • View the total number of authentication requests per application over time.

The count of successful authentications is the total number of FLOW.UPDATED events with COMPLETED status during the specified period.

For example, suppose you want to see the number of authentications (per application) per day for a three-day period starting on September 1, 2019. Requests to this service require the following filter parameter to define the query:

  • occurredAt

    Specifies the start date for the period of interest. For this example, to specify a date range starting on September 1, 2019, the value is occurredAt ge "2019-09-01T00:00:00Z".

Requests to this service also require the following query parameters to define the query:

  • samplePeriod

    Specifies the time interval in hours. For this example, to specify a daily interval, the value is samplePeriod=24.

  • samplePeriodCount

    Specifies the number of sample periods. For this example, to specify three days of results, the value is samplePeriodCount=3.

The authentications per application service supports limit as an optional query parameter to specify a subset of applications returned in the response. For information about limiting collections, refer to Conventions.

Authentications per application data model

Property Type Required? Mutable? Description

endDate

Date

Required

Mutable

The date and time the authentication data collection ends (ISO 8601 format).

partial

Boolean

Optional

Mutable

Indicates the partial period. When visible in the response data and set to true, this indicates that the response represents a shorter duration than requested through the samplePeriod parameter.

signons

Integer

Required

Mutable

The number of authentications for the application identified by its application ID between the start and end dates of the sample period.

startDate

Date

Required

Mutable

The date and time the authentication data collection starts (ISO 8601 format).

Response codes

Code Message

200

Successful operation.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.

500

Internal server error.