Supported Events
This article provides details about the events currently covered by the Salesforce App Analytics API.
Table of contents
- Overview
- User Interface Events
- Custom Object Events
- Platform Events
- Understanding Event Types
- Salesforce UI Interaction (URI)
- Visualforce Page Views
- Lightning Pages and Components
- Custom Object Events
- REST and SOAP APIs
- Apex
- Visualforce Remoting
- Log Record Types for Custom Objects (Operation Source in the ISVapp UI)
Overview
Event Type | API Support |
|---|---|
Salesforce UI Interactions | Supported |
Visualforce Page Views | Supported |
Platform Events | Supported |
Lightning |
|
Apex |
|
API |
|
Tableau CRM |
|
Flows | Not yet supported |
Platform Cache | Not yet supported |
In-App Guidance | Not yet supported |
Report Executions | Not yet supported |
Salesforce Connect | Not yet supported |
Change Data Capture | Not yet supported |
Workflows (deprecated) | Not supported |
Process Builder (deprecated) | Not supported |
User Interface Events
Salesforce tracks multiple types of user interactions with either the standard Salesforce UI or with custom functionality offered by ISV and OEM partners:
Salesforce UI Interactions
Visualforce Page Views
Lightning Page and Component Views
Custom Object Events
Event tracking is limited to custom objects only; events related to standard objects like Account and Contact will not be covered by the Salesforce App Analytics API. Currently custom object operations originating from the following sources can be monitored:
REST and SOAP APIs
Apex
Asynchronous Apex (Batch Apex, Queueable, Future)
Scheduled Jobs
REST and SOAP Web Services
Visualforce Remoting
Platform Events
Platform events are part of Salesforce's messaging platform. If you have specified custom platform events then the Salesforce App Analytics API will track related operations.
Understanding Event Types
Salesforce UI Interaction (URI)
Events triggered through the Salesforce user interface are fully supported.
Visualforce Page Views
There are two different event types related to Visualforce pages: simple page views and Visualforce Remoting events. Visualforce Remoting calls will result in custom object events that will be covered in the section below.
You can leverage Visualforce Pages as action overrides (e.g. Contact New) to get insights on standard objects that are currently not covered by the Salesforce App Analytics API.
Lightning Pages and Components
Please refer to our specific guide about Lightning Events.
Custom Object Events
Custom object events will include the affected object name as well as the operation count, i.e. the number of records affected in the transaction. The sum of operations will reflect the total volume of records being affected, whereas the sum of event rows will reflect the total number of transactions for the respective object.
REST and SOAP APIs
There are multiple APIs that allow for programmatic access to standard Salesforce functionality. Events triggered through the official REST and SOAP API will be tracked.
Apex
Batch Apex and Scheduled Jobs
Record operations invoked through executions made by Batch Apex, Queueables, Future methods or Scheduled jobs.
Apex REST and SOAP Web Services
Both Web Services allow for programmatic access to Apex functionality. Custom object events that are triggered through exposed Apex functionality will be tracked by the Salesforce App Analytics API.
Visualforce Remoting
Visualforce Remoting is used to call annotated methods in Apex controllers via JavaScript. Custom object events that are triggered in those Apex controllers will be tracked by the Salesforce App Analytics API.
The following Apex events are currently not supported by the Salesforce App Analytics API:
Apex Triggers
Apex Controllers (unless used in Visualforce Remoting)
Log Record Types for Custom Objects (Operation Source in the ISVapp UI)
The following list outlines the possible sources of custom object operations:
Value | Description |
|---|---|
API | Logs standard Salesforce API requests made to the org |
ApexExecution | Tracks the execution of Apex code, including triggers, classes, and anonymous Apex |
ApexRestApi | Logs calls to Apex REST endpoints |
ApexSoap | Logs calls to Apex SOAP web services |
BulkApiV1 | Captures jobs and operations performed through the Bulk API v1 |
BulkApiV2 | Captures jobs and operations performed through the Bulk API v2 |
QueuedExec/Apex Batch Job | Represents the execution of asynchronous operations such as Queueable Apex |
RestApi/API (REST) | Logs REST API calls made to Salesforce endpoints |
UnassociatedCRUD | Records CRUD operations on custom objects that don't map to a known App Analytics log type |
URI/Salesforce UI Interaction (URI) | Captures requests made to specific Salesforce URI endpoints |
VFRemoting | Logs JavaScript remoting calls made from Visualforce pages |
VisualforceRequest | Tracks requests and page views of Visualforce pages |
CronJob/Apex Scheduled Job | Logs the execution of scheduled Apex jobs and other timed processes |
PlatformEventConsumer/Platform Event | Tracks delivery of platform events to subscribers such as triggers or flows |