afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/AnalyticsInteractEventLog.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage"
  ],
  "title": "AnalyticsInteractEventLog - Data API",
  "description": "Analytics Interact Event Log represents route or page changes made in the CRM Analytic UI. This object is available in API version 61.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AnalyticsSessionIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of a particular session of CRM Analytics. Use this field to determine which log lines originated from a particular session."
    },
    "AnalyticsTimestamp": {
      "type": "datetime",
      "properties": "Filter, Nillable, Sort",
      "description": "The time when this log line was generated."
    },
    "ClickCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of clicks performed on a page in the CRM Analytics UI."
    },
    "ClientIp": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "CpuTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "LoginKey": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "ReadTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The amount of time a user spent on a particular tab."
    },
    "RecordIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The unique ID of the CRM Analytics object."
    },
    "RequestIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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 RequestIdentifier. For example: 3nWgxWbDKWWDIk0FKfF5DV."
    },
    "RunTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The amount of time that the request took in milliseconds."
    },
    "SessionCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of times a user returned to a particular page."
    },
    "SessionKey": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "TabIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the particular Analytics tab in the UI."
    },
    "Timestamp": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The access time of Salesforce services in GMT. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting."
    },
    "TotalTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The total amount of time (in milliseconds) a tab is open."
    },
    "Type": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The CRM Analytics object type."
    },
    "Uri": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The URI of the page that’s receiving the request. For example: /home/home.jsp."
    },
    "UserIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the user who’s using Salesforce services through the UI or the API. For example: 00530000009M943."
    },
    "ViewMode": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The view mode for the CRM Analytics asset. Possible values include view edit present JSON print"
    }
  },
  "special_access_rules": "To access this object, you must have the View Event Log Object Data user permission.",
  "usage": "This event type is captured when a tab is closed. It 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 then return, and logged only when the tab is closed."
}