Read Active Identity Counts by Date Range
GET {{apiPath}}/environments/{{envID}}/metrics/activeIdentityCounts?filter=startDate%20ge%20%222022-05-01T19:00:00Z%22&limit=10&order=-startDate&samplingPeriod=MONTH
The operation GET /environments/{{envID}}/metrics/activeIdentityCounts returns active identity counts for a selected environment over a specified time period.
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 per month starting 2020-05-01T19:00:00Z. There are 10 months of active identity counts returned per page.
| 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). |
Note: For more information about SCIM syntax and operators, paging, ordering, and limiting collections, see Conventions.
A response includes a number of sample periods from the startDate until the current date and time. Each sample period contains the following properties.
| Property | Type | Required? | Description |
|---|---|---|---|
endDate | Date | Required | The date and time active identity count data collection ends (ISO 8601 format). Note: This value is automatically calculated based on the startDate and samplePeriod. |
startDate | Date | Required | The date and time active identity count data collection starts (ISO 8601 format). |
value | Integer | N/A | The active identity count for the specified time period. |
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 | ||
samplingPeriod | string |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/metrics/activeIdentityCounts?filter=startDate%20ge%20%222020-05-01T19%3A00%3A00Z%22\u0026limit=10\u0026samplePeriod=DAY\u0026order=-startDate"},"previous":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/metrics/activeIdentityCounts?cursor=ewogICJpbml0aWFsU3RhcnREYXRlIiA6ICIyMDIwLTA1LTAxVDAwOjAwOjAwWiIsCiAgInBhZ2VTdGFydERhdGUiIDogIjIwMjAtMDUtMTFUMDA6MDA6MDBaIiwKICAic2FtcGxlUGVyaW9kIiA6ICJEQVkiLAogICJsaW1pdCIgOiAxMCwKICAiZGVzY2VuZGluZyIgOiB0cnVlCn0%3D"}},"_embedded":{"activeIdentityCounts":[{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-10T00:00:00Z","endDate":"2020-05-10T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-09T00:00:00Z","endDate":"2020-05-09T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-08T00:00:00Z","endDate":"2020-05-08T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-07T00:00:00Z","endDate":"2020-05-07T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-06T00:00:00Z","endDate":"2020-05-06T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-05T00:00:00Z","endDate":"2020-05-05T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-04T00:00:00Z","endDate":"2020-05-04T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-03T00:00:00Z","endDate":"2020-05-03T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-02T00:00:00Z","endDate":"2020-05-02T23:59:59.999Z"},{"_links":{"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"value":0,"startDate":"2020-05-01T00:00:00Z","endDate":"2020-05-01T23:59:59.999Z"}]},"count":17,"size":10}