Activity

Report client activity

Changed on

Report events that happen to results within a Glean client UI, such as search result views and clicks. This signal improves search quality.

post/rest/api/v1/feedback

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/feedback
  • Auth: HTTP bearer

Query parameters

feedbackstring

A URL encoded versions of Feedback. This is useful for requests.

Request body

idstring

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'ANNOUNCEMENT' | 'ANSWERS' | 'ARTIFACTS' | 'AUTOCOMPLETE' | 'COLLECTIONS' | 'FEED' | 'SEARCH' | 'CHAT' | 'NTP' | 'WORKFLOWS' | 'SUMMARY' | 'GENERAL' | 'PRISM' | 'PROMPTS'

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.

trackingTokensstring[] required

A list of server-generated trackingTokens to which this event applies.

event'CLICK' | 'CONTAINER_CLICK' | 'COPY_LINK' | 'CREATE' | 'DISMISS' | 'DOWNVOTE' | 'EMAIL' | 'EXECUTE' | 'FILTER' | 'FIRST_TOKEN' | 'FOCUS_IN' | 'LAST_TOKEN' | 'MANUAL_FEEDBACK' | 'MANUAL_FEEDBACK_SIDE_BY_SIDE' | 'FEEDBACK_TIME_SAVED' | 'MARK_AS_READ' | 'MESSAGE' | 'MIDDLE_CLICK' | 'PAGE_BLUR' | 'PAGE_FOCUS' | 'PAGE_LEAVE' | 'PREVIEW' | 'RELATED_CLICK' | 'RIGHT_CLICK' | 'SECTION_CLICK' | 'SEEN' | 'SELECT' | 'SHARE' | 'SHOW_MORE' | 'UPVOTE' | 'VIEW' | 'VISIBLE' required

The action the user took within a Glean client with respect to the object referred to by the given trackingToken.

positioninteger

Position of the element in the case that the client controls order (such as feed and autocomplete).

payloadstring

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.

timestampstring date-time

The ISO 8601 timestamp when the event occured.

pathnamestring

The path the client was at when the feedback event triggered.

channelsstring[]

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.

urlstring

The URL the client was at when the feedback event triggered.

uiTreestring[]

The UI element tree associated with the event, if any.

uiElementstring

The UI element associated with the event, if any.

applicationIdstring

The application ID of the client that sent the feedback event.

agentIdstring

The agent ID of the client that sent the feedback event.

Example request

{
  "trackingTokens": [
    "trackingTokens"
  ],
  "event": "VIEW"
}

Response

OK

Changes

  • eb8771f34824Revision changes
    • info

      added the new NOT_A_QUESTION enum value to the request property //

    • info

      added the new UNSURE_IF_CORRECT enum value to the request property //

  • 12f321ae935eRevision changes
    • info

      the endpoint scheme security APIToken was added to the API