ApiUsageApi
Use this API to retrieve metrics about an org's API usage. With this functionality in place, administrators can monitor the usage of APIs within a specified timespan, as well as a breakdown of commonly-used APIs sorted by number of requests.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| get-total-count-v1 | GET /api-usage/v1/count | Total number of API requests |
| list-api-summary-v1 | GET /api-usage/v1/summary | Get Api Summary |
get-total-count-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Total number of API requests This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: method: eq startDate: gt, eq endDate: lt, eq | [optional] [default to undefined] |
Return type
object
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ApiUsageApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new ApiUsageApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const filters: string = method eq "GET", startDate gt "2025-08-01"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* (optional)
const result = await apiInstance.getTotalCountV1({ });
console.log(result);
list-api-summary-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get Api Summary This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
| filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: method: eq startDate: gt, eq endDate: lt, eq | [optional] [default to undefined] |
| limit | number | Max number of results to return. | [optional] [default to 250] |
| offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. Defaults to 0 if not specified. | [optional] [default to undefined] |
Return type
Array<SummaryResponse>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { ApiUsageApi } from '@sailpoint/api-client';
import { Configuration } from '@sailpoint/api-client';
const configuration = new Configuration();
const apiInstance = new ApiUsageApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const filters: string = method eq "GET", startDate gt "2025-08-01"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* (optional)
const limit: number = 100; // Max number of results to return. (optional)
const offset: number = 10; // Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
const result = await apiInstance.listApiSummaryV1({ });
console.log(result);