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

50 lines
2.0 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",
"usage"
],
"title": "SearchClickEventLog - Data API",
"description": "Search Click Event Log contains details about the users interaction with the search results. This object is available in API version 61.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ClickedRecordIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the result the user clicked in the search results page."
},
"QueryIdentifier": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Unique ID of the search query."
},
"Rank": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Ranking of the result clicked in the search results page."
},
"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."
},
"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."
},
"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."
}
},
"special_access_rules": "To access this object, you must have the View Event Log Object Data user permission.",
"usage": "All searches within the app, including Experience Cloud sites, are included. However, unauthenticated guest users dont have a unique Salesforce user ID."
}