Overview
The API Usage dashboard provides organization administrators with real-time visibility into monthly API call volumes. It helps track consumption against your plan limits, manage team integrations, and set up automated alerts to avoid service disruptions.
Accessing the API Usage Dashboard
Click on the Account icon in the lower left part of the dashboard, and select Organization Dashboard.
Click API Usage.
Understanding Your API Consumption Metrics
The Billing period card displays usage data grouped by calendar month:
Metric | Description |
Billing period | The active calendar month window (e.g., Nov 1 – Nov 30, 2026). Use the dropdown menu to review previous billing cycles. |
Usage Progress Bar | Shows the overall percentage and count of requests consumed out of your total limit. |
Included requests | Total number of API requests allocated under your subscription plan for the selected period. |
Used | Number of successful API calls executed during the selected billing period. |
Remaining | Requests still available before reaching your plan’s threshold. |
Exporting Usage Records
To download raw consumption metrics for auditing or internal reporting:
Navigate to API Usage.
In the top-right corner of the Billing Period section, click Export CSV.
The CSV file will automatically download to your device, containing itemized request logs for the selected cycle.
Configuring Email Notifications
Set up automated email alerts to inform stakeholders when your organization approaches its API request quota.
Adding a Notification
Scroll down to the Email notifications card.
Click the + Add notification button.
Specify:
Threshold Percentage: The usage milestone that triggers the alert (e.g., 50%, 80%, or 90%).
Recipients: Enter email addresses for whoever should receive the alert. You can add up to 10 recipients, and they do not need to have Prodeal accounts.
Click Save.
Managing Existing Notifications
Editing a Notification: Click the pencil icon next to any created notification to adjust its threshold percentage or recipient list.
Toggling Alerts On/Off: Use the toggle switch next to a created notification to turn it off or on at any time without having to delete it.
Deleting a Notification:
Click the delete icon (trash can) next to the notification you want to remove.
A confirmation modal will appear titled Delete notification?, stating:
"Are you sure you want to delete this notification? Its recipients will no longer be emailed when usage reaches [X]%."
Click Delete to confirm permanent removal, or click Cancel / the X icon to keep the alert.
Notification Behavior
Each notification is sent once per billing period the first time consumption reaches the defined threshold.
If your plan is upgraded or included requests increase during a cycle, alerts will re-arm and send again when the new threshold is reached.