Wave Interaction Event Type

Wave Interaction events represent route or page changes made in the CRM Analytics user interface. A Wave Interaction event type is captured when a tab is closed. It also collates the interaction statistics over the life of the tab, including total open time, read time, and so on. These statistics are aggregated as you go to other tabs and return, and logged only once when the tab is closed.

Because Wave Interaction events are logged only when the tab or browser window is closed, these events might not match Wave Change events exactly if a user allows their Salesforce session to time out before closing.

Note

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

Fields

Field	Details
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 `WaveInteraction`.
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`.
NUM_CLICKS	Type Number Description The number of clicks performed on a page in the CRM Analytics user interface.
NUM_SESSIONS	Type Number Description The number of times a user returned to a particular page.
ORGANIZATION_ID	Type Id Description The 15-character ID of the organization. For example: `00D000000000123`.
READ_TIME	Type Number Description The amount of time a user spent on a particular tab.
RECORD_ID	Type String Description The Salesforce ID of the CRM Analytics object.
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.
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. 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.
TOTAL_TIME	Type Number Description The total amount of time a tab was open in milliseconds.
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.

Object Reference for the Salesforce Platform

Wave Interaction Event Type

Fields

See Also