View Source OpenApiTypesense.Analytics (OpenApiTypesense v0.2.1)

Provides API endpoints related to analytics

Summary

Functions

create_analytics_event(body, opts \\ [])

Create an analytics event

Sending events for analytics e.g rank search results based on popularity.

create_analytics_event(conn, body, opts)

create_analytics_rule(body, opts \\ [])

Creates an analytics rule

When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.

create_analytics_rule(conn, body, opts)

delete_analytics_rule(ruleName, opts \\ [])

@spec delete_analytics_rule(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete an analytics rule

Permanently deletes an analytics rule, given it's name

delete_analytics_rule(conn, ruleName, opts)

retrieve_analytics_rule(ruleName, opts \\ [])

@spec retrieve_analytics_rule(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieves an analytics rule

Retrieve the details of an analytics rule, given it's name

retrieve_analytics_rule(conn, ruleName, opts)

retrieve_analytics_rules(opts \\ [])

@spec retrieve_analytics_rules(keyword()) ::
  {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error

Retrieves all analytics rules

Retrieve the details of all analytics rules

retrieve_analytics_rules(conn, opts)

@spec retrieve_analytics_rules(
  OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error

upsert_analytics_rule(ruleName, body, opts \\ [])

Upserts an analytics rule

Upserts an analytics rule with the given name.

upsert_analytics_rule(conn, ruleName, body, opts)