Gleanex.Client.Activity (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to activity

Summary

Functions

Report document activity

Report client activity

Types

t()

@type t() :: %Gleanex.Client.Activity{events: [Gleanex.Client.ActivityEvent.t()]}

Functions

activity(body, opts \\ [])

@spec activity(body :: map(), opts :: keyword()) :: :ok | {:error, Gleanex.Error.t()}

Report document activity

Report user activity that occurs on indexed documents such as viewing or editing. This signal improves search quality.

Request Body

Content Types: application/json

feedback(body, opts \\ [])

@spec feedback(body :: Gleanex.Client.Feedback.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Report client activity

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

Options

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

Request Body

Content Types: application/json