Report client activity

post/feedback

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

SecurityBearerAuth
Request
query Parameters
feedback
string

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

header Parameters
X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json
event
required
string

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

Enum: Description
CLICK

The object's primary link was clicked with the intent to view its full representation. Depending on the object type, this may imply an external navigation or navigating to a new page or view within the Glean app.

CONTAINER_CLICK

A link to the object's parent container (e.g. the folder in which it's located) was clicked.

COPY_LINK

The user copied a link to the primary link.

CREATE

The user creates a document.

DISMISS

The user dismissed the object such that it was hidden from view.

DOWNVOTE

The user gave feedback that the object was not useful.

EMAIL

The user attempted to send an email.

FIRST_TOKEN

The first token of a streaming response is received.

FOCUS_IN

The user clicked into an interactive element, e.g. the search box.

LAST_TOKEN

The final token of a streaming response is received.

MANUAL_FEEDBACK

The user submitted textual manual feedback regarding the object.

MARK_AS_READ

The user explicitly marked the content as read.

MESSAGE

The user attempted to send a message using their default messaing app.

MIDDLE_CLICK

The user middle clicked the object's primary link with the intent to open its full representation in a new tab.

PAGE_BLUR

The user puts a page out of focus but keeps it in the background.

PAGE_FOCUS

The user puts a page in focus, meaning it is the first to receive keyboard events.

PAGE_LEAVE

The user leaves a page and it is unloaded (by clicking a link, closing the tab/window, etc).

PREVIEW

The user clicked the object's inline preview affordance.

RIGHT_CLICK

The user right clicked the object's primary link. This may indicate an intent to open it in a new tab or copy it.

SECTION_CLICK

The user clicked a link to a subsection of the primary object.

SEEN

The user has likely seen the object (e.g. took action to make the object visible within the user's viewport).

SHARE

The user shared the object with another user.

SHOW_MORE

The user clicked the object's show more affordance.

UPVOTE

The user gave feedback that the object was useful.

VIEW

The object was visible within the user's viewport.

VISIBLE

The object was visible within the user's viewport.

trackingTokens
required
Array of strings

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

applicationId
string

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

category
string

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.

Enum: "ANNOUNCEMENT" "AUTOCOMPLETE" "COLLECTIONS" "FEED" "SEARCH" "CHAT" "PROMPTS" "NTP" "SUMMARY"
channels
Array of strings

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.

Items Enum: "COMPANY" "GLEAN"
id
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.

object (ManualFeedbackInfo)
pathname
string

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

payload
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.

position
integer

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

object (SeenFeedbackInfo)
object (SessionInfo)
timestamp
string <date-time>

The ISO 8601 timestamp when the event occured.

uiElement
string

The UI element associated with the event, if any.

url
string

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

object (User)
object (UserViewInfo)
Responses
200

OK

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{
  • "trackingTokens": [
    • "trackingTokens"
    ],
  • "event": "VIEW"
}