The GET /organizations/{organizationId}/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.

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 1/1/2020, aggregatedBy = calendarMonth, and limit = 2, the results would include two groups. The first group would be for the number of active users 1/1/2020 to 1/31/2020. The second group would be for the number of active users 2/1/2020 to 2/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.

Query Parameters

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.

Data Model

Each item (grouping) of the results includes the following properties.

Property Description
activeUsers (number) 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-time string) The start date and time of the item. For the earliest item, this is the start date and time of the license.
endDate (date-time string) 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.