The operation GET /environments/{environmentId}/metrics/activeIdentityCounts returns active identity counts for a selected environment over a specified time period.

For 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.

Query parameters

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.
samplePeriod 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).

Data model

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 Description
endDate 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 The date and time active identity count data collection starts (ISO 8601 format).
value An integer that specifies 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.