How do you use the API Usage and API Usage Cost reports?
Track the usage and monthly cost of different API connections from a single view.
API usage and cost tracking
API usage shows the recorded consumption figures of the APIs on a daily basis. A separate API usage costs summarizes the costs of the supported service in euros per month. Use the usage report to find deviations and the cost report for preliminary budget monitoring, but check the billing against the actual invoice from the service provider.
Run API Usage Report
The API Usage report can be found in the Reports view of the Dashboard.
- Open Reports and search for API Usage .
- Select Run Report .
- Set the date range. The default is the last 30 days.
- If necessary, select an API name or leave all included.
- Check the result in the Preview tab or export the entire result in CSV format.
The report groups events with the same API name into rows by day, with the most recent day first. On the same day, API names are arranged alphabetically.
Read daily usage
When you use the API Usage report, each row contains:
- API name : The name of the service or function stored for the usage event.
- Day : calendar day of usage events.
-
Total consumption : sum of the day's
consumedvalues. - Number of lines : the number of usage lines recorded for the day.
Total consumption does not necessarily mean the number of API calls, tokens, or products processed. The unit depends on what the integration in question stores consumed field. The number of rows indicates the number of storage events, not necessarily the number of web requests made to the external service.
Examine the usage peak
It is worth clarifying the unusual day in the API usage report based on the API name and the simultaneous change.
- Compare the Total Spend and Number of Lines values to previous corresponding days.
- Check if the increase is related to a campaign, mass update of product data, integration deployment, or background processing.
- If consumption increases but the amount of work processed does not, check the API process queue and the service log for retries, errors, and a possible loop.
- Limit the same API name and export a longer period in CSV format to confirm the trend.
Run the API Usage Costs report
API usage costs are its own report in the Reports view, not a tab in the API Usage report.
- Find API usage costs and select Run Report or Graph .
- Select a date range and, if necessary, an API name.
- Read the table for Month , API Name , Total Consumption , and Expenses .
- The chart shows the monthly Monthly Expenses (EUR) series.
The cost calculation includes the first 10 consumption units of a month and API name at no cost. It prices the next 90, the next 900, and beyond at three descending tiers. The calculation only produces a cost for OpenAI Product Description Service tiers that are priced separately in the code; the cost for an unknown or free API name is zero.
Limit expense report usage
The API Usage Costs report calculates the monthly free share and price tiers only from usage rows within the selected date range. If the selection starts in the middle of the month, previous usage for the same month is discarded and the calculation starts the free share and tiers again. This partial month result may underestimate the cost.
Use full calendar months in your expense report. Do not interpret partial month rows in the default selection of the last 30 days as the final monthly expense. The prices in the report are calculation rules stored in the code, and the view does not contain the current service provider price list. Always match your budgeting to the contract and invoice.
The API name menu only contains a subset of the names recognized by the calculation. All API names are only visible when the name delimiter is left blank.