Read User Activities
GET {{apiPath}}/environments/{{envID}}/userActivities
The GET /environments/{{envID}}/userActivities operation returns the counts for successful and failed sign-on actions as well as a count for password resets over a designated period of time.
If a startDate and endDate filtering parameter is not specified, the request returns all user activity information for the past 30 days. If a sampleSize filtering parameter is not specified, the default sample size value is DAY.
To fine-tune the result data, you can specify a SCIM filtering expression to designate specific date ranges and sample sizes. In the sample, the SCIM filter (URL-encoded) returns data showing the user-activities that occurred from a startDate of 2018-02-17
to an endDate of 2018-02-23
.
Note: If your startDate and endDate filter values are less than or equal to five days, then the result data defaults to a sampleSize value of HOURS. The response data shows the collected event list for each hour interval.
| Parameter | Description |
|---|---|
filter | Filters results for the specified date range. Both startDate and endDate values must be specified. (ISO 8601 format) See filtering details below. |
sampleSize | Determines how the data is sized when returned. This can be HOUR, DAY, WEEK. The default value is determined based on the date range used. If the date range is less than or equal to 5 days, HOUR is used. If the date range is greater than 5 or less than or equal to 60, DAY is used. If the date range is greater than 60, WEEK is used. |
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/{{envID}}/userActivities?filter=startDate eq "2019-01-01T00:00:00Z" AND EndDate eq "2019-02-31T23:59:00Z"
These SCIM operators are supported in the filtering expression:
eq(equals)
The attribute and operator values must be identical.
Note: These SCIM operators are not supported: gt (greater than), lt (less than), ge (greater than or equal to), le (less than or equal to), in (includes), ne (not equal), co (contains), sw (starts with), ew (ends with), pr (present, is a non-empty or non-null value), not (logical NOT), or (logical OR), and (logical AND).
For more information about SCIM syntax and operators, see Conventions.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | null | Filters results for the specified date range in ISO 8601 format. | |
sampleSize | string | How the data is sized when returned. See documentation for usage. |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/userActivities?filter=startDate%20eq%20%222022-05-17T09%3A10%3A12-04%3A00%22%20and%20endDate%20eq%20%222022-05-23T09%3A10%3A12-04%3A00%22"}},"_embedded":{"userActivities":[{"startDate":"2022-05-18T00:00:00-04:00","endDate":"2022-05-19T00:00:00-04:00","userSignOns":{"successes":6,"failures":0},"passwordResets":0},{"startDate":"2022-05-19T00:00:00-04:00","endDate":"2022-05-20T00:00:00-04:00","userSignOns":{"successes":3,"failures":0},"passwordResets":0},{"startDate":"2022-05-20T00:00:00-04:00","endDate":"2022-05-21T00:00:00-04:00","userSignOns":{"successes":22,"failures":0},"passwordResets":0},{"startDate":"2022-05-21T00:00:00-04:00","endDate":"2022-05-22T00:00:00-04:00","userSignOns":{"successes":0,"failures":0},"passwordResets":0},{"startDate":"2022-05-22T00:00:00-04:00","endDate":"2022-05-23T00:00:00-04:00","userSignOns":{"successes":0,"failures":0},"passwordResets":0}]}}