API consumption

Monitoring the number of API calls made in your organization is helpful for optimizing and troubleshooting your integrations. It also provides you with clear visibility into their API usage and consumption.

The statistics include API calls made by the following API consumers:

• workspace
• profile (all types)
• tracker key
• AI API key (legacy)

Viewing API call statistics

You can view the data as:

• a graph
• a CSV report (same data as the graph)
• a comprehensive report

1. Sign in to Synerise.
2. Enter an organization.
   If you can’t see any organizations next to the workspace list, it means you don’t have access to an organization.
3. Go to Statistics.
4. Click the API calls tab.
5. If you don’t want to set any filters, view the graph or the CSV report.
6. If you want to set filters, see Setting the filters.

Setting the filters

The filters apply to the graph and to the CSV report.

1. In the Filter API Calls section, choose the data to show.
   By default, the report shows all API calls from all workspaces in the current month.

   

   You can narrow down the data by using the following filters:

   • Workspace - Filters by workspaces.
   • Auth Keys - Filters by API keys and tracker keys.
   • Permissions - Filter by permission names.
     Some permissions allow multiple endpoints.
   • Endpoints - Filters by endpoints (paths).
   • Call type - Filters by HTTP methods.
   • HTTP Status - Filters by HTTP response statuses.

2. Adjust the time range and calculation method:

   • Show as:
     • Count - Shows the data separately for each period.
     • Incremental - Shows the total for each period including the count from earlier periods.
   • Date range - Sets the start and end date of the query. By default, the data is from the current month.

3. Adjust the data grouping options:

   • Group by - Groups the data in the graph by a facet. By default, the data is grouped by date.
   • Interval - Changes the columns in the graph to show the data by days (default) or months.

4. See the graph or download a CSV report.

Graph

In the graph:

• Selection is the number of calls that met the filters.
• Total is the number of all calls in the selected period.
• Each column is one unit of time (day or month, depending on the Interval setting).
• The columns illustrate API calls according to the Group by setting.
• You can hover over a column to see the details.
• In the legend under the graph, you can select and deselect values from the graph. The value type depends on the Group by setting.
• You can see a brief summary of the data in the table under the legend.

CSV report

1. Under the filters, click Download CSV.
2. Save the report on your computer and open it.

Each report in the row corresponds to a resource (for example: endpoint, workspace) according to the Group by setting.
The columns are:

• date: the day or month that the row describes.
• periodCount: the total number of API calls to show in the graph for the period (count or incremental, according to the Show as setting).
• periodTransferSize: the total number of bytes transferred in the period in all API calls (count or incremental).
• label: the name of the resource (for example: endpoint path, workspace name) that the row describes.
• count: the number of API calls associated with the resource in the graph (count or incremental).
• transferSize: the number of bytes transferred in this period in API calls associated with the resource requests to this endpoint (count or incremental).