The API Usage Historical Report helps managers and administrators understand API usage over time. High-level usage trends are combined with detailed endpoint data so you can track patterns, investigate unexpected changes, and plan for capacity. Use this report to:
-
Monitor frequent API calls at the client application level.
-
Drill into specific endpoints to understand usage patterns.
-
Understand how API usage changes day-to-day or over time.
-
Identify unusual spikes or drops in API calls that may indicate a problem.
The Analytics Metric Trend Report is based on data from two widgets:
-
API Usage Summary widget
-
API Usage Detail widget
Use Case
Clarissa Dalloway manages integrations with several internal systems that rely on APIs. She is responsible for keeping these integrations stable, secure, and predictable. She wants to understand how different client applications and endpoints are using the APIs over time so she can monitor consumption, investigate unusual patterns, and plan for future growth.
Clarissa opens the API Usage Historical report. She reviews the API Usage Summary widget to examine API call volume by client application over the last 30 days. She looks for increases or decreases that align with expected releases, configuration changes, or new integrations coming online. This helps her confirm whether usage is within expected limits or if there are sudden spikes that could cause performance or capacity issues.
Clarissa notices an increase in API call volume that does not align with any expected events. Next, she uses the API Usage Detail widget to look at invocation counts, endpoints, return codes, and client application IDs on the day of the increase.
Clarissa notices that one client application shows a sharp increase in invocation count for a particular endpoint. She uses the detailed rows on the API Usage Detail widget to see which methods, paths, and hours are responsible for the spike, exports the data for further analysis, and shares it with her development team so they can adjust their integration and manage API consumption going forward.
Permissions
You must have these permissions:
-
Dashboard > Dashboard Templates > API Usage Historical: On
-
Dashboard > Dashboards: View
-
Dashboard > Dashboards: Edit (optional)
If you cannot access the reporting templates or Dashboard, check with your administrator. The administrator can find these permissions in NiCE CXone. Go to Admin > Security Settings > Roles and Permissions and select the role.
API Usage Summary Widget
The API Usage Summary widget provides a daily summary of API call volumes by client application for the selected time frame.
From this widget, you can:
-
View a summary of API call volume across one or more client applications over time.
-
Identify usage spikes or drops for specific client applications.
-
Validate whether API consumption patterns align with expected integration behavior.
This widget is configured as follows:
-
Default date range: Last 30 days
-
Maximum date range: 95-day window
-
Metrics selector: None
Additional filters for this widget include:
-
None
The table below describes the columns in this widget:
|
Column Name |
Description |
|---|---|
|
Date |
Calendar date when the API calls occurred. |
|
Client Application ID |
Unique identifier of the client application that made the API call. |
|
Client Application Name |
Display name of the client application that made the API call. |
|
API Call Count |
Total number of API calls made by the client application on the given date. |
API Usage Detail Widget
The API Usage Detail widget provides detailed insights into API usage for each client application, date, hour, HTTP method, and endpoint.
From this widget, you can:
-
Focus on specific client applications or methods to understand their detailed usage patterns.
-
Export the data to CSV or Excel for further analysis or sharing with other teams.
This widget is configured as follows:
-
Default date range: Today
-
Maximum date range: 95-day window
-
Metrics selector: None
Additional filters for this widget include:
-
Method
The table below describes the columns in this widget:
|
Column Name |
Description |
|---|---|
|
Date |
Calendar date of the API usage. |
|
Hour |
Timestamp of the API usage. |
|
Client Application ID |
Unique identifier of the client application that initiated the API call. |
|
Client Application Name |
Display name of the client application associated with the API usage. |
|
Method |
HTTP method used in the API request. |
|
API Path |
Path of the API endpoint that was called. |
|
Return Code |
HTTP return code from the API response. |
|
Invocation Count |
Number of times the endpoint was invoked for the given date, hour, client application, method, and return code. |