mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 00:02:34 +08:00
240 lines
12 KiB
JSON
240 lines
12 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules"
|
||
],
|
||
"title": "LightningPageViewEventLog - Data API",
|
||
"description": "Lightning Page View event logs represent information about the page on which the event occurred in Lightning Experience and the Salesforce mobile app. A Lightning Page View event log tracks the page a user visited, how long the user spent on the page, and the load time for the page. This object is available in API version 61.0 and later.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"possible_values",
|
||
"example"
|
||
],
|
||
"fields": {
|
||
"AppName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name of the application that the user accessed."
|
||
},
|
||
"BrowserName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name of the browser that the user accessed. For example: Chrome, IE, Safari, Gecko."
|
||
},
|
||
"BrowserVersion": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version."
|
||
},
|
||
"ClientGeolocation": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The geolocation of the client in the form of <Country>/<State|Province>. For example: United States/California."
|
||
},
|
||
"ClientIdentifier": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The API client ID."
|
||
},
|
||
"ClientIp": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "IP address of the client employing salesforce.com services."
|
||
},
|
||
"ConnectionType": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The type of connection. Possible values are: CDMA1x CDMA EDGE EVDO0 EVDOA EVDOB GPRS HRPD HSDPA HSUPA LTE WIFI"
|
||
},
|
||
"DeviceIdentifier": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The unique identifier used to identify a device when tracking events. DeviceIdentifier is a generated value that’s created when the mobile app is initially run after installation."
|
||
},
|
||
"DeviceModel": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name of the device model. For example: iPad, iPhone."
|
||
},
|
||
"DevicePlatform": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The type of application experience in name:experience:form format. Possible values are: Name APP_BUILDER CUSTOM S1 SFX Experience BROWSER HYBRID Form DESKTOP PHONE TABLET"
|
||
},
|
||
"DeviceSessionIdentifier": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started. For example: 321a1ddfaf924803a075f1e69fc87bc06f53ccd0."
|
||
},
|
||
"DoesEffectivePageTimeDeviate": {
|
||
"type": "boolean",
|
||
"properties": "Defaulted on create, Filter, Group, Sort",
|
||
"description": "When a deviation is detected, DoesEffectivePageTimeDeviate records true. The default value is false."
|
||
},
|
||
"Duration": {
|
||
"type": "double",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The duration in milliseconds since the page start time. This field is being deprecated. Use EffectivePageTime instead."
|
||
},
|
||
"EffectivePageTime": {
|
||
"type": "double",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "Indicates how many milliseconds it took for the page to load before a user could interact with the page’s functionality. Multiple factors can affect effective page time, such as network speed, hardware performance, or page complexity. If an effective page time greater than 60 seconds is detected, the value of this field is set to null or 0."
|
||
},
|
||
"EffectivePageTimeErrorType": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "Indicates the origin of an error. This field is populated when EFFECTIVE_PAGE_TIME_DEVIATION_REASON contains the PAGE_HAS_ERROR value."
|
||
},
|
||
"EffectivePageTimeReason": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The reason for deviation in page loading time. Examples of possible values include: PageInDom- The page was loaded from a cache PageHasError- An undefined page loading error occurred."
|
||
},
|
||
"GrandparentUiElement": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The grandparent scope of the page element where the event occurred."
|
||
},
|
||
"LoginKey": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The string that ties together all events in a 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."
|
||
},
|
||
"MobileSdkAppType": {
|
||
"type": "string",
|
||
"description": "The mobile SDK application type.",
|
||
"possible_values": "HYBRID HYBRIDLOCAL HYBRIDREMOTE NATIVE REACTNATIVE"
|
||
},
|
||
"MobileSdkVersion": {
|
||
"type": "String",
|
||
"description": "The mobile SDK application version number.",
|
||
"example": "5.0"
|
||
},
|
||
"OperatingSystemName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The operating system name, derived from UserAgent. For example: Android, iOS, OSX, Windows."
|
||
},
|
||
"OperatingSystemVersion": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The operating system version, derived from UserAgent."
|
||
},
|
||
"PageAppName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The internal name of the application that the user accessed from the App Launcher. For example: LightningSales."
|
||
},
|
||
"PageContext": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name of the component hosting the main content of the page. For example: clients:cardsContainer."
|
||
},
|
||
"PageObjectIdentifier": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The unique entity identifier of the event. For example: 0013000000I3zJAAAZ."
|
||
},
|
||
"PageObjectType": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The object type of the event. For example: task, contacts."
|
||
},
|
||
"PageStartTime": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The time when the page was initially loaded, measured in milliseconds. For example: 1471564788642."
|
||
},
|
||
"PageUrl": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "Relative URL of the top-level Lightning Experience or Salesforce mobile app page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PageUrl. For example: /sObject/0064100000JXITSAA5/view."
|
||
},
|
||
"ParentUiElement": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The parent scope of the page element where the event occurred."
|
||
},
|
||
"PreviousPageAppName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The internal name of the previous application that the user accessed from the App Launcher. For example: LightningSales."
|
||
},
|
||
"PreviousPageContext": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The context of the previous page where the event occurred. For example: clients:cardsContainer."
|
||
},
|
||
"PreviousPageObjectIdentifier": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The unique previous page object identifier of the event."
|
||
},
|
||
"PreviousPageObjectType": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The previous page object type of the event. For example: task, contacts."
|
||
},
|
||
"PreviousPageUrl": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened. For example: /sObject/006410000."
|
||
},
|
||
"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."
|
||
},
|
||
"SdkAppVersion": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The SDK application version number. For example: 5.0."
|
||
},
|
||
"SessionKey": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session is started. For example: cdd09305cb6babf34059e27f70e47f1b11dec868."
|
||
},
|
||
"TargetUiElement": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The target page element where the event occurred. For example: label bBody truncate, tabitem-link."
|
||
},
|
||
"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."
|
||
},
|
||
"UiEventSequenceNumber": {
|
||
"type": "double",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "An auto-incremented sequence number of the current event since the session started."
|
||
},
|
||
"UiEventTimestamp": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "An auto-incremented sequence number of the current event since the session started."
|
||
},
|
||
"UserAgent": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string."
|
||
},
|
||
"UserIdentifier": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The 15-character ID of the user accessing Salesforce services through the UI or API. For example: 00530000009M943."
|
||
},
|
||
"UserType": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The category of user license of the user accessing Salesforce services through the UI or API. Possible values are: A: Automated Process b: High Volume Portal C: Customer Portal User D: External Who F: Self Service G: Guest L: Package License Manager N: Salesforce to Salesforce n: CSN Only O: Power Custom o: Custom P: Partner p: Customer Portal Manager S: Standard X: Salesforce Administrator"
|
||
}
|
||
},
|
||
"special_access_rules": "To access this object, you must have the View Event Log Object Data user permission."
|
||
} |