Skip to content

Latest commit

 

History

History
28 lines (25 loc) · 19.2 KB

File metadata and controls

28 lines (25 loc) · 19.2 KB

Feedback

Fields

Field Type Required Description
id Optional[str] 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[models.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.
tracking_tokens List[str] ✔️ A list of server-generated trackingTokens to which this event applies.
event models.Event ✔️ The action the user took within a Glean client with respect to the object referred to by the given trackingToken.
position Optional[int] Position of the element in the case that the client controls order (such as feed and autocomplete).
payload Optional[str] 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.
session_info Optional[models.SessionInfo] N/A
timestamp date The ISO 8601 timestamp when the event occured.
user Optional[models.User] N/A
pathname Optional[str] The path the client was at when the feedback event triggered.
channels List[models.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[str] The URL the client was at when the feedback event triggered.
ui_tree List[str] The UI element tree associated with the event, if any.
ui_element Optional[str] The UI element associated with the event, if any.
manual_feedback_info Optional[models.ManualFeedbackInfo] N/A
manual_feedback_side_by_side_info Optional[models.ManualFeedbackSideBySideInfo] N/A
seen_feedback_info Optional[models.SeenFeedbackInfo] N/A
user_view_info Optional[models.UserViewInfo] N/A
workflow_feedback_info Optional[models.WorkflowFeedbackInfo] N/A
application_id Optional[str] The application ID of the client that sent the feedback event.
agent_id Optional[str] The agent ID of the client that sent the feedback event.