Skip to main content

Service Health and ConsumptionService Health and Consumption Guide

API Consumption Details

The API Consumption Details page provides an overview of your monthly API data consumption, including information on how much data you have available and your top API endpoints and keys in terms of consumption.

Consumption Breakdown

This pie chart displays how much data you've consumed versus how much available data you have left. Move your pointer over the graph slices to view the represented values.

API-Consumption-Breakdown.png

Top API Endpoints

This table displays the API endpoints that have consumed the most call data over the current month. You may need to use the scroll bar on the right to view all the rows.

Top-API-Endpoints.png

Top API Keys

This table displays the API keys that have consumed the most call data over the current month. You may need to use the scroll bar on the right to view all the rows.

API Overview

This table displays the individual call data volume consumed by different API keys over the selected timeframe. You may need to use the scroll bar on the right to view all the rows.

To modify the filter setting, click the filter icon and select a timeframe from the menu.

API-Overview-Filter.png

The following timeframes are available:

  • Prior 7 days: Displays data from the previous seven days. For example, if you were viewing the dashboards on July 8th, you would see data from July 1st through July 7th. Dates are based on UTC time.

  • Month to date: Displays daily data totals from the beginning of the current month to the previous day.

  • Prior calendar month: Displays daily data from the previous month. For example, if you were in the month of October, this option would display data from the entire month of September.

  • Prior 3 calendar months: Displays the data totals in three-day increments over the last three calendar months. For example, if you were in the month of October, this option would display data from July through September.

  • Prior 12 calendar months: Displays monthly data totals from the last 12 calendar months. For example, if you were viewing the dashboards during the month of October 2023, this option would display data from October 2022 through September 2023.

  • All months: Displays monthly data totals from the start of your subscription through the previous month.

API Calls by Key

The API Calls by Key chart displays the details of top five API keys based on the number of API calls made by the API keys in the timeframe that you select in an incremental stacked manner. The details are displayed in descending order based on the number of API calls made by each API key that you created for retrieving or updating data from various Exabeam services such as Cloud Collectors, Context Management, Correlation Rules, and Site Collectors for the selected timeframe.

API_calls_by_Key.png

Based on the timeframe that you select, the chart displays the relevant details.

Sawooth_chart_final_GIF.gif