Read Active Identity Counts by License
GET {{apiPath}}/organizations/{{orgID}}/licenses/{{licenseID}}/metrics/activeIdentityCounts?aggregatedBy=calendarMonth&limit=20&order=-startDate
The GET /organizations/{{orgID}}/licenses/{{licenseID}}/metrics/activeIdentityCounts operation returns the number of active users per license for a specified time period. The time period and grouping of results is derived from two query parameters: aggregatedBy and limit. All results start on the first day of the license 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 aggregatedBy query parameter is required. If aggregatedBy = licenseYear, the request returns the number of active users grouped by year. If aggregatedBy = calendarMonth, the request returns the number of active users grouped by month.
The number of groupings returned is determined by the limit query parameter. For example, if the license period started on January 1, 2020, aggregatedBy = calendarMonth, and limit = 2, the results would include two groups. The first group would be for the number of active users January 1, 2020 to January 31, 2020. The second group would be for the number of active users February 1, 2020 to February 29, 2020. If the number of groupings surpasses the current date, the last (or first, depending on the sort order) grouping ends on the current date.
Path Parameters
| Parameter | Description |
|---|---|
organizationID (string) | Required The specific organization the client is interested in. |
licenseID (string) | Required The specific license for which the client wants the number of annual active users or monthly active users. |
| Parameter | Description |
|---|---|
aggregatedBy (string) | Required Possible values are licenseYear and calendarMonth. If licenseYear, the request returns the number of annual active users. If calendarMonth, the request returns the number of monthly active users. |
limit (int) | The number of items in a response. This value is a number from 1 to 1000. If not specified, the default value is 12. |
order (string) | Defines the sort order of results. Possible values are startDate (ascending) and -startDate (descending). If not specified, the default value is startDate. |
Each item (grouping) of the results includes the following properties.
| Property | Type | Required? | Description |
|---|---|---|---|
activeUsers | Integer | Required | The number of active users for the time period indicated. For aggregatedBy = licenseYear, the results are grouped into yearly time periods. For aggregatedBy = calendarMonth, the results are grouped into monthly time periods. |
startDate | Date | Required | The start date and time of the item. For the earliest item, this is the start date and time of the license. |
endDate | Date | Required | The end date and time of the item. |
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 |
|---|---|---|---|
aggregatedBy | string | ||
limit | number | ||
order | string |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983/metrics/activeIdentityCounts?limit=20\u0026aggregatedBy=calendarMonth\u0026order=-startDate"}},"_embedded":{"activeIdentityCounts":[{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-11-01T00:00:00Z","endDate":"2020-11-02T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-10-01T00:00:00Z","endDate":"2020-10-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":2,"startDate":"2020-09-01T00:00:00Z","endDate":"2020-09-30T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-08-01T00:00:00Z","endDate":"2020-08-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-07-01T00:00:00Z","endDate":"2020-07-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-06-01T00:00:00Z","endDate":"2020-06-30T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-05-01T00:00:00Z","endDate":"2020-05-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-04-01T00:00:00Z","endDate":"2020-04-30T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-03-01T00:00:00Z","endDate":"2020-03-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":0,"startDate":"2020-02-01T00:00:00Z","endDate":"2020-02-29T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2020-01-01T00:00:00Z","endDate":"2020-01-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2019-12-01T00:00:00Z","endDate":"2019-12-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":0,"startDate":"2019-11-01T00:00:00Z","endDate":"2019-11-30T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2019-10-01T00:00:00Z","endDate":"2019-10-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2019-09-01T00:00:00Z","endDate":"2019-09-30T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2019-08-01T00:00:00Z","endDate":"2019-08-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2019-07-01T00:00:00Z","endDate":"2019-07-31T23:59:59.999Z"},{"_links":{"license":{"href":"https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"}},"activeUsers":1,"startDate":"2019-06-06T00:00:00Z","endDate":"2019-06-30T23:59:59.999Z"}]},"count":18,"size":18}