The User Activities API tracks and aggregates user-activity information on user sign on attempts and total active user counts. The service uses stream processors that listen to the users and login_attempts events. These events are collected and presented by time period. The service supports a query filtering parameter to request user-activity information for a specific date range and sample size.

Filtering data

For large collections, filtering expressions can be added to the request URL to limit the response data by date. For example, this SCIM filter returns user activity data from the start date of “2019-01-01” and an end date of “2019-02-31”:

https://api.pingone.com/v1/environments/{environmentid}/userActivities?filter=startDate eq "2019-01-01T00:00:00Z" AND EndDate eq "2019-02-31T23:59:00Z"

These SCIM parameters are applicable:

These SCIM operators are supported in the filtering expression:

For more information about SCIM syntax and operators, see Conventions.

User activities data model

Property Description
startDate The start date for the activity period.
endDate The end date for the activity period.
environment.id A string that specifies the environment resource’s unique identifier.
userSignOns.successes An integer that specifies the total number of successful user sign ons for the activity period.
userSignOns.failures An integer that specifies the total number of failed user sign ons for the activity period.
passwordResets An integer that specifies the total number of password resets for the activity period.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
404 The requested resource was not found.