Newer Version Available

This content describes an older version of this product. View Latest

Wave Change Event Type

Wave Change events represent route or page changes made in the CRM Analytics user interface. A Wave Change event type is captured every time the user opens a new CRM Analytics asset or tab, switches between tabs, or changes dashboard pages. Wave Change events are logged when opening new tabs and switching back to previously opened tabs.

For details about event monitoring, see the Trailhead Event Monitoring module or REST API Developer’s Guide.

Fields

Field Details
ANALYTICS_MODE
Type
String
Description
The location in which the dashboard is displayed. In the Salesforce mobile app, embedded dashboards are logged as embedded first. When a user interacts with the dashboard, a full-screen dashboard is displayed to allow for user interaction, and is logged as mobileNative.
Possible values are:
  • studio—Analytics Studio
  • tab—Analytics tab
  • embedded— Embedded in Aura or Lightning.
  • embeddedInCommunities— Embedded in Experience Cloud.
  • mobileNative— CRM Analytics mobile app for iOS/Android or Salesforce mobile app for iOS/Android
CLIENT_IP
Type
String
Description
The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CPU_TIME
Type
Number
Description
The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
EVENT_TYPE
Type
String
Description
The type of event. The value is always WaveChange.
IS_MOBILE
Type
Boolean
Description
If true, the dashboard is displayed in the Tableau CRM mobile app for iOS and Android, in the Salesforce mobile app for iOS and Android, or in a mobile browser.
IS_NEW
Type
Boolean
Description
The field indicates that this action opens a new tab or goes back to a previously opened tab. If the change routes to a new page, the value of this field is true. If it routes to an existing page, this field is false.
LOGIN_KEY
Type
String
Description
The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
For example: GeJCsym5eyvtEK2I.
ORGANIZATION_ID
Type
Id
Description
The 15-character ID of the organization.
For example: 00D000000000123.
PAGE_CONTEXT
Type
String
Description
The context of the page in which the dashboard is displayed. In the Salesforce mobile app, embedded dashboards are logged as aura first. When a user interacts with the dashboard, a full-screen dashboard is displayed to allow for user interaction, and is logged as iOS or android.
Possible values are:
  • aura—Lightning Components
  • vf—Visualforce
  • iOS— CRM Analytics or Salesforce mobile app for iOS
  • android— CRM Analytics or Salesforce mobile app for Android
PAGE_ID
Type
String
Description

The ID of the CRM Analytics dashboard page.

This field is only available in v58.0 and higher.

RECORD_ID
Type
String
Description
The Salesforce ID of the CRM Analytics object.
REOPEN_COUNT
Type
Number
Description
If IS_NEW is false, the number of times that an existing page opens.
REQUEST_ID
Type
String
Description
The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
For example: 3nWgxWbDKWWDIk0FKfF5DV.
RUN_TIME
Type
Number
Description
The amount of time that the request took in milliseconds.
SAVED_VIEW_ID
Type
String
Description
The ID of the CRM Analytics dashboard saved view.
SESSION_KEY
Type
String
Description
The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
For example: d7DEq/ANa7nNZZVD.
TAB_ID
Type
String
Description
The ID of the particular Analytics tab in the user interface.
For example: dashboard-0FKB0000000Ec64GDK.
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
TYPE
Type
String
Description
The CRM Analytics object type.
URI
Type
String
Description
The URI of the page that’s receiving the request.
For example: /home/home.jsp.
URI_ID_DERIVED
Type
ID
Description
The 18-character case insensitive ID of the URI of the page that’s receiving the request.
USER_ID
Type
Id
Description
The 15-character ID of the user who’s using Salesforce services through the UI or the API.
For example: 00530000009M943.
USER_ID_DERIVED
Type
Id
Description
The 18-character case insensitive ID of the user who’s using Salesforce services through the UI or the API.
For example: 00590000000I1SNIA0.
VIEW_MODE
Type
String
Description
The view mode for the CRM Analytics asset. Possible values include view, edit, present, json, or print.
WAVE_SESSION_ID
Type
String
Description
The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session.
WAVE_TIMESTAMP
Type
Number
Description
The time at which this log line was generated.