Read Active Identity Counts
GET {{apiPath}}/environments/{{envID}}/activeIdentityCounts?filter=startDate%20ge%20%222019-05-01T19:00:00Z%22%20and%20samplingPeriod%20eq%20%2210%22&limit=10&order=-startDate
You can get active identity counts for a selected environment over a specified time period. The GET /environments/{{envID}}/activeIdentityCounts request must specify a SCIM filtering expression that designates a start date and a sampling period value in the request URL.
Currently, the active identity count does not return product-specific counts (such as, for PingOne SSO, MFA, or Protect), nor does it count active users when DaVinci is used.
The example operation returns active identity counts for the designated number of sampling periods from the specified start date. The end date is set automatically to the current date, and cannot be set manually in the request.
These SCIM operators can be applied to the following attributes:
eq(equals)
Supported attributes: samplingPeriod
ge(greater than or equal to)
Supported attributes: startDate
and(logical AND)
Logical AND for building compound expressions in which both expressions are true.
Note: These SCIM operators are not supported: gt (greater than), lt (less than), le (less than or equal to), ne (not equal), co (contains), ew (ends with), in (includes), pr (present, is a non-empty or non-null value), sw (starts with), or (logical OR), not (logical NOT).
For more information about SCIM syntax and operators, paging, ordering, and limiting collections, see Conventions.
| Parameter | Description |
|---|---|
startDate | Required. The date and time active identity count data collection starts (ISO 8601 format). You must apply the SCIM filter ge (greater than or equal to) to this parameter. See the preceeding example. Note: Collection ends on the current date and time. |
samplingPeriod | Required Defines whether active identity counts are returned per day or per month. Possible values are DAY and MONTH. |
limit | Defines how many sample periods are returned per page. For samplePeriod = DAY, this is a number between 1 and 730. For samplePeriod = MONTH, this is a number between 1 and 24. |
order | Defines the sort order. Possible values are startDate (ascending) and -startDate (descending). |
| Property | Type | Required? | Description |
|---|---|---|---|
startDate | Date | Required | The date and time active identity count data collection starts (ISO 8601 format). |
samplePeriod | String | Optional | Defines the grouping of results. Valid values are DAY or MONTH. |
limit | Integer | Optional | The number of sample periods per page in the response. Valid range is 1-730 for DAY or 1-24 for MONTH. |
order | String | Optional | Determines the ordering of results. Values are startDate for ascending, or -startDate for descending. |
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. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | ||
limit | number | ||
order | string |
RESPONSES
status: OK
{"_links":{"next":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activeIdentityCounts?cursor=ewogICJzdGFydFBlcmlvZCIgOiAiMjAxOS0wNy0wNFQyMzowMFoiLAogICJlbmRQZXJpb2QiIDogIjIwMTktMDYtMzBUMTk6MDBaIiwKICAiZW5kRGF0ZSIgOiAiMjAxOS0wNy0wOFQxNzoxMDo1OS4xODNaIiwKICAibGFzdEN1bXVsYXRpdmUiIDogMCwKICAiZGVzY2VuZGluZyIgOiB0cnVlLAogICJsaW1pdCIgOiAxMCwKICAic3RhcnREYXRlIiA6ICIyMDE5LTA1LTAxVDE5OjAwWiIsCiAgInNhbXBsaW5nUGVyaW9kIiA6IDEwCn0%3D"},"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activeIdentityCounts?filter=startDate%20ge%20%222019-05-01T19%3A00%3A00Z%22%20and%20samplingPeriod%20eq%20%2210%22\u0026limit=10\u0026order=-startDate"}},"_embedded":{"activeIdentityCounts":[{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-08T17%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-08T17%3A10%3A58.183Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-08T17:00:00Z","endDate":"2019-07-08T17:10:58.183Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-08T07%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-08T16%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-08T07:00:00Z","endDate":"2019-07-08T16:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-07T21%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-08T06%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-07T21:00:00Z","endDate":"2019-07-08T06:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-07T11%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-07T20%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-07T11:00:00Z","endDate":"2019-07-07T20:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-07T01%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-07T10%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-07T01:00:00Z","endDate":"2019-07-07T10:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-06T15%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-07T00%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-06T15:00:00Z","endDate":"2019-07-07T00:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-06T05%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-06T14%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-06T05:00:00Z","endDate":"2019-07-06T14:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-05T19%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-06T04%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-05T19:00:00Z","endDate":"2019-07-06T04:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-05T09%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-05T18%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":1,"cumulative":1,"startDate":"2019-07-05T09:00:00Z","endDate":"2019-07-05T18:59:59Z"},{"_links":{"activities":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities?filter=recordedat%20gt%20%222019-07-04T23%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-07-05T08%3A59%3A59Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"}},"value":0,"cumulative":1,"startDate":"2019-07-04T23:00:00Z","endDate":"2019-07-05T08:59:59Z"}]},"count":164,"size":10}