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

103 lines
5.5 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": "AnalyticsDownloadEventLog - Data API",
"description": "AnalyticsDownloadEventLog represent downloads made from lens and dashboard in the CRM Analytics. 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."
},
"AssetIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The asset ID from the user download."
},
"AssetType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The asset type from the user download."
},
"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."
},
"DatasetIdentifiers": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "A comma-separated list of used dataset IDs."
},
"DownloadFormat": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The format of the data for export."
},
"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."
},
"RecordCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The number of records exported."
},
"RequestIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Globally unique identifier for a given request."
},
"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."
},
"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."
},
"UserType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The category of user license. Possible values are: CsnOnly—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. CspLitePortal—CSP Lite Portal license. Users whose access is limited because theyre organization customers and access the application through a customer portal or an Experience Cloud site. CustomerSuccess—Customer Success license. Users whose access is limited because theyre organization customers and access the application through a customer portal. Guest—Users whose access is limited so that your customers can view and interact with your site without logging in. PowerCustomerSuccess—Power Customer Success license. Users whose access is limited because theyre organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. PowerPartner—Power Partner license. Users whose access is limited because theyre partners and typically access the application through a partner portal or site. SelfService—Users whose access is limited because theyre organization customers and access the application through a self-service portal. Standard—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses, and admins for this org."
}
},
"special_access_rules": "To access this object, you must have the View Event Log Object Data user permission."
}