Report client activity

curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "trackingTokens": [
    "trackingTokens"
  ],
  "event": "VIEW"
}'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Scio-Actas

string

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

X-Glean-Auth-Type

string

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

Query Parameters

feedback

string

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

Body

application/json

trackingTokens

string[]

required

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

event

enum<string>

required

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

Available options:

CLICK,

CONTAINER_CLICK,

COPY_LINK,

CREATE,

DISMISS,

DOWNVOTE,

EMAIL,

EXECUTE,

FILTER,

FIRST_TOKEN,

FOCUS_IN,

LAST_TOKEN,

MANUAL_FEEDBACK,

MARK_AS_READ,

MESSAGE,

MIDDLE_CLICK,

PAGE_BLUR,

PAGE_FOCUS,

PAGE_LEAVE,

PREVIEW,

RELATED_CLICK,

RIGHT_CLICK,

SECTION_CLICK,

SEEN,

SHARE,

SHOW_MORE,

UPVOTE,

VIEW,

VISIBLE

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

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

Available options:

ANNOUNCEMENT,

AUTOCOMPLETE,

COLLECTIONS,

FEED,

SEARCH,

CHAT,

NTP,

WORKFLOWS,

SUMMARY,

GENERAL,

PROMPTS

position

integer

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

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.

sessionInfo

object

timestamp

string

The ISO 8601 timestamp when the event occured.

user

object

pathname

string

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

channels

enum<string>[]

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.

Available options:

COMPANY,

GLEAN

url

string

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

uiTree

string[]

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

uiElement

string

The UI element associated with the event, if any.

manualFeedbackInfo

object

manualFeedbackInfo.email

string

The email address of the user who submitted the Feedback.event.MANUAL_FEEDBACK event.

manualFeedbackInfo.source

enum<string>

The source associated with the Feedback.event.MANUAL_FEEDBACK event.

Available options:

AUTOCOMPLETE,

CALENDAR,

CHAT,

CHAT_GENERAL,

CONCEPT_CARD,

DESKTOP_APP,

DISAMBIGUATION_CARD,

EXPERT_DETECTION,

FEED,

GENERATED_Q_AND_A,

INLINE_MENU,

NATIVE_RESULT,

Q_AND_A,

RELATED_QUESTIONS,

REPORT_ISSUE,

SCIOBOT,

SEARCH,

SIDEBAR,

SUMMARY

manualFeedbackInfo.issue

string

deprecated

The issue the user indicated in the feedback.

manualFeedbackInfo.issues

enum<string>[]

The issue(s) the user indicated in the feedback.

Available options:

INACCURATE_RESPONSE,

INCOMPLETE_OR_NO_ANSWER,

INCORRECT_CITATION,

MISSING_CITATION,

OTHER,

OUTDATED_RESPONSE,

RESULT_MISSING,

RESULT_SHOULD_NOT_APPEAR,

RESULTS_HELPFUL,

RESULTS_POOR_ORDER,

TOO_MUCH_ONE_KIND

manualFeedbackInfo.imageUrls

string[]

URLs of images uploaded by user when providing feedback

manualFeedbackInfo.query

string

The query associated with the Feedback.event.MANUAL_FEEDBACK event.

manualFeedbackInfo.obscuredQuery

string

The query associated with the Feedback.event.MANUAL_FEEDBACK event, but obscured such that the vowels are replaced with special characters. For search feedback events only.

manualFeedbackInfo.activeTab

string

Which tabs the user had chosen at the time of the Feedback.event.MANUAL_FEEDBACK event. For search feedback events only.

manualFeedbackInfo.comments

string

The comments users can optionally add to the Feedback.event.MANUAL_FEEDBACK events.

manualFeedbackInfo.searchResults

string[]

The array of search result Glean Document IDs, ordered by top to bottom result.

manualFeedbackInfo.previousMessages

string[]

The array of previous messages in a chat session, ordered by oldest to newest.

manualFeedbackInfo.chatTranscript

object[]

Array of previous request/response exchanges, ordered by oldest to newest.

manualFeedbackInfo.numQueriesFromFirstRun

integer

How many times this query has been run in the past.

manualFeedbackInfo.vote

enum<string>

The vote associated with the Feedback.event.MANUAL_FEEDBACK event.

Available options:

UPVOTE,

DOWNVOTE

manualFeedbackInfo.rating

integer

A rating associated with the user feedback. The value will be between one and the maximum given by ratingScale, inclusive.

manualFeedbackInfo.ratingKey

string

A description of the rating that contextualizes how it appeared to the user, e.g. "satisfied".

manualFeedbackInfo.ratingScale

integer

The scale of comparison for a rating associated with the feedback. Rating values start from one and go up to the maximum specified by ratingScale. For example, a five-option satisfaction rating will have a ratingScale of 5 and a thumbs-up/thumbs-down rating will have a ratingScale of 2.

seenFeedbackInfo

object

userViewInfo

object

workflowFeedbackInfo

object

applicationId

string

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

Response

200

Was this page helpful?

Suggest edits Raise issue

Create AnnouncementCreate a textual announcement visible to some set of users based on department and location.

curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "trackingTokens": [
    "trackingTokens"
  ],
  "event": "VIEW"
}'

Indexing API

Client API

Actions API

Authorizations

Headers

Query Parameters

Body

Response