| Field | Type | Required | Description |
|---|---|---|---|
id |
Optional<String> | ➖ | Universally unique identifier of the event. To allow for reliable retransmission, only the earliest received event of a given UUID is considered valid by the server and subsequent are ignored. |
category |
Optional<FeedbackCategory> | ➖ | The feature category to which the feedback applies. These should be broad product areas such as Announcements, Answers, Search, etc. rather than specific components or UI treatments within those areas. |
trackingTokens |
List<String> | ✔️ | A list of server-generated trackingTokens to which this event applies. |
event |
Event | ✔️ | The action the user took within a Glean client with respect to the object referred to by the given trackingToken. |
position |
Optional<Long> | ➖ | Position of the element in the case that the client controls order (such as feed and autocomplete). |
payload |
Optional<String> | ➖ | For type MANUAL_FEEDBACK, contains string of user feedback. For autocomplete, partial query string. For feed, string of user feedback in addition to manual feedback signals extracted from all suggested content. |
sessionInfo |
Optional<SessionInfo> | ➖ | N/A |
timestamp |
OffsetDateTime | ➖ | The ISO 8601 timestamp when the event occured. |
user |
Optional<User> | ➖ | N/A |
pathname |
Optional<String> | ➖ | The path the client was at when the feedback event triggered. |
channels |
List<FeedbackChannel> | ➖ | Where the feedback will be sent, e.g. to Glean, the user's company, or both. If no channels are specified, feedback will go only to Glean. |
url |
Optional<String> | ➖ | The URL the client was at when the feedback event triggered. |
uiTree |
List<String> | ➖ | The UI element tree associated with the event, if any. |
uiElement |
Optional<String> | ➖ | The UI element associated with the event, if any. |
manualFeedbackInfo |
Optional<ManualFeedbackInfo> | ➖ | N/A |
manualFeedbackSideBySideInfo |
Optional<ManualFeedbackSideBySideInfo> | ➖ | N/A |
seenFeedbackInfo |
Optional<SeenFeedbackInfo> | ➖ | N/A |
userViewInfo |
Optional<UserViewInfo> | ➖ | N/A |
workflowFeedbackInfo |
Optional<WorkflowFeedbackInfo> | ➖ | N/A |
applicationId |
Optional<String> | ➖ | The application ID of the client that sent the feedback event. |
agentId |
Optional<String> | ➖ | The agent ID of the client that sent the feedback event. |