Read Total Identity Counts

GET {{apiPath}}/environments/{{envID}}/totalIdentities?filter=startDate%20eq%20%222019-05-01T19:00:00Z%22%20and%20endDate%20eq%20%222019-05-31T19:00:00Z%22

You can get the total count of unique identities associated with a selected environment for a specified time period (per day). The GET /environments/{{envID}}/totalIdentities request must provide a SCIM filtering expression in the request URL that designates a date range. The sample specifies a date range from 2019-03-01 through 2019-04-01 (sample size of 32 days).

Filtering result data

The GET request for total identities requires a SCIM filter to specify start and end dates for the response data. For example, this SCIM filter returns active identity counts divided into time periods of one day from the start date of 2019-01-01 to the end date of 2019-02-01:

https://api.pingone.com/v1/environments/{{envID}}/totalIdentities?filter=startDate eq "2019-01-01T00:00:00+00:00" and endDate eq "2019-02-01T00:00:00+00:00"

These SCIM operators can be applied to the following attributes:

• eq (equals)

Supported attributes: startDate and endDate

• 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), ge (greater than or equal to), 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.

Request Params

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/totalIdentities"}},"_embedded":{"totalIdentities":[{"date":"2019-03-01T00:00:00.000Z","totalIdentities":5},{"date":"2019-03-02T00:00:00.000Z","totalIdentities":5},{"date":"2019-03-03T00:00:00.000Z","totalIdentities":5},{"date":"2019-03-04T00:00:00.000Z","totalIdentities":5},{"date":"2019-03-05T00:00:00.000Z","totalIdentities":5},{"date":"2019-03-06T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-07T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-08T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-09T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-10T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-11T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-12T00:00:00.000Z","totalIdentities":4},{"date":"2019-03-13T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-14T00:00:00.000Z","totalIdentities":5},{"date":"2019-03-15T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-16T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-17T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-18T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-19T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-20T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-21T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-22T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-23T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-24T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-25T00:00:00.000Z","totalIdentities":6},{"date":"2019-03-26T00:00:00.000Z","totalIdentities":7},{"date":"2019-03-27T00:00:00.000Z","totalIdentities":7},{"date":"2019-03-28T00:00:00.000Z","totalIdentities":8},{"date":"2019-03-29T00:00:00.000Z","totalIdentities":7},{"date":"2019-03-30T00:00:00.000Z","totalIdentities":7},{"date":"2019-03-31T00:00:00.000Z","totalIdentities":7},{"date":"2019-04-01T00:00:00.000Z","totalIdentities":7}]},"count":7,"size":32}