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

103 lines
4.4 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules"
],
"title": "AnalyticsPerfEventLog - Data API",
"description": "Analytics Perf Event Log helps track trends in your Analytics performance. 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 is generated."
},
"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”. 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."
},
"EffectivePageTime": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The experienced page time in milliseconds."
},
"IsInitialLoad": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the event is for the initial load of the Dashboard (true) or not (false). The default value is false."
},
"LoginKey": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The string that ties together all events in a given users login session. It starts with a login event and ends with either a logout event or the user session expiring. For example: GeJCsym5eyvtEK2I."
},
"QueriedName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The asset title or query string."
},
"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."
},
"SessionKey": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The users 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."
},
"Uri": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The URI of the page thats receiving the request. For example: /home/home.jsp."
},
"UserIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the user whos 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."
}