Back to Help Center

Supported Events

Last modified on 2022-11-30

This article provides details about the events currently covered by the Salesforce App Analytics API.

Table of contents

Overview

Event Type

API Support

Salesforce UI Interactions

Supported

Visualforce Page Views

Supported

Platform Events

Supported

Lightning
Page Views
Page Interactions
Component Views
Component Interactions
Nested Aura Components
Nested LWC Components


Supported
Supported
Supported
Supported
Not supported
Not supported

Apex
Asynchronous Apex (Batch Apex, Queueable, Future)
Scheduled Jobs
REST Web Services
SOAP Web Services
Visualforce Remoting
Apex Executions (Triggers, Controllers)
Unhandled Exceptions


Supported
Supported
Supported
Supported
Supported
Supported
Supported

API
SOAP API
REST API
BULK API


Supported
Supported
Supported (Winter '22)

Tableau CRM
Analytics Dashboard
Analytics Lens


Supported (Winter '22)
Supported (Winter '22)

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

Events are split into Lightning page views and Lightning interactions. Lightning interactions are mostly automatically generated system events - these are not actual "interactions", like clicking a button. Be aware that if you provide components that will be embedded multiple times on a page layout, each respective component will trigger an event in case the parent page is loaded. For example, embedding multiple lightning components on an Account detail page will result in multiple events if the detail page is viewed.

Nested Lightning Components

Please be aware that nested (also referred to as composite or embedded) Aura or LWC components are currently not being tracked. This includes:

  • Aura or LWC nested in Visualforce pages

  • Any other composite Aura or LWC components, e.g. components nested in other components

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)

Did not find what you were looking for?

Please let us know: [email protected]