Monitor Event Usage Against Your Allocations
Check your event publishing and delivery usage and maximum allocation in Setup, or using REST API or Apex.
Check your event publishing and delivery usage in the user interface. From Setup, in the Quick Find box, enter Platform Events, and then select Platform Events. The usage is shown in the Event Allocations section.
If your org purchased the add-on for platform events or change data capture, the grace allocation is displayed in addition to the allocation for daily event delivery. The daily event delivery usage corresponds to the DailyDeliveredPlatformEvents REST API limits value. The monthly event delivery usage is also displayed. It corresponds to the MonthlyPlatformEvents REST API limits value. To view the usage-based entitlement in Setup, check the Usage-based Entitlements related list in the Company Information page.
Learn about other ways to check event usage with REST API, Apex, and in the Company Information page.
| Allocation | Default Allocations | Add-On License |
|---|
Event Delivery: number of delivered event messages to CometD and Pub/Sub API clients, empApi Lightning components, and event relays | If your org hasn’t purchased the add-on, check your usage in one of these ways. - Daily event delivery usage in the last 24 hours using REST API: check the
DailyDeliveredPlatformEvents value with the REST API limits resource. - Daily event delivery usage in the last 24 hours using Apex: use the
System.OrgLimit class and check the DailyDeliveredPlatformEvents value.
The daily event delivery usage is updated within a few minutes after event delivery. | If your org has purchased the add-on, check your usage in one of these ways.- Daily event delivery in the last 24 hours as mentioned in the previous column.
- Monthly event delivery usage: From Setup, in the Quick Find box, enter
Platform Events, and then select Platform Events. The monthly event delivery usage is displayed in the Event Allocations section. In the REST API limits resource, this value corresponds to MonthlyPlatformEvents in API version 47.0 and earlier. This value in the UI and API is updated within a few minutes after event delivery. - Usage-based entitlement: From Setup, in the Quick Find box, enter
Company Information, and then select Company Information. The usage is shown under the Usage-based Entitlements related list. In the REST API limits resource, this value corresponds to MonthlyPlatformEventsUsageEntitlement in API version 48.0 and later. This value in the UI and API is updated once a day.
|
| Event Publishing: number of event messages published per hour | With the REST API limits resource: usage information is returned in HourlyPublishedPlatformEvents. | With the REST API limits resource: usage information is returned in HourlyPublishedPlatformEvents. |
See Also
j