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

214 lines
8.5 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules"
],
"title": "LightningErrorEventLog - Data API",
"description": "Lightning Error events represent errors that occurred during user interactions with Lightning Experience and the Salesforce mobile app. This object is available in API version 64.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"example",
"examples"
],
"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.",
"example": "Chrome, Safari"
},
"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 dont 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>.",
"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": "The IP address of the client thats using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”."
},
"ComponentName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The internal name of the standard component that generated the error. The Salesforce developer assigned the name when the standard component was created."
},
"ConnectionType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of connection."
},
"DeviceIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value thats 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.",
"example": "iPad, iPhone"
},
"DevicePlatform": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of application experience in name:experience:form format."
},
"DeviceSessionIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The unique identifier of the users session based on page load time. If the user reloads a page, it starts a new session."
},
"ErrorMessage": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The error message generated."
},
"LoginKey": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The string that ties together all events in a users login session. It starts with a login event and ends with either a logout event or the user session expiring."
},
"MobileSdkAppType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The mobile application type."
},
"MobileSdkVersion": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Mobile SDK version number."
},
"OperatingSystemName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The operating system name.",
"example": "Android, iOS, OSX, Windows"
},
"OperatingSystemVersion": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The operating system version."
},
"PageAppName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The internal name of the application that the user accessed from the App Launcher."
},
"PageContext": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Context of the page where the event occurred."
},
"PageObjectIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Unique entity ID of event."
},
"PageObjectType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The entity type of event"
},
"PageStartTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "Time when page was initially loaded"
},
"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."
},
"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"
},
"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 REQUEST_ID."
},
"SdkAppVersion": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The mobile SDK application version number."
},
"SessionKey": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The users unique session ID. You can use this value to identify all events in Lightning Experience within a session. When a user logs out and logs in again, a new session is started."
},
"StackTrace": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The stack trace contains the location in the code where the error occurred along with the calling frames that led to the error."
},
"Timestamp": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"example": "20130715233322.670"
},
"UiEventIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the Lightning event type."
},
"UiEventSequenceNumber": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The sequence number of current event since start of session."
},
"UiEventSource": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"examples": "Here are some examples of error flags returned in this field. AuraError Error InvalidStateError RangeError ReferenceError SecurityError SyntaxError TypeError unknown"
},
"UiEventTimestamp": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time at which this event occurred, measured in milliseconds."
},
"UiEventType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of error event."
},
"UserAgent": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The numeric code for the type of client used to make the request (for example, 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."
},
"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."
}
},
"special_access_rules": "To access this object, you must have the View Event Log Object Data user permission."
}