OpenApiTypesense.Analytics (OpenApiTypesense v1.0.3)

View Source

Provides API endpoints related to analytics

Summary

Functions

create_analytics_event(body, opts \\ [])

(since 0.4.0)

Create an analytics event

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

create_analytics_rule(body, opts \\ [])

(since 0.4.0)
@spec create_analytics_rule(
  body :: OpenApiTypesense.AnalyticsRuleSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

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.

delete_analytics_rule(rule_name, opts \\ [])

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

Delete an analytics rule

Permanently deletes an analytics rule, given it's name

retrieve_analytics_rule(rule_name, opts \\ [])

(since 0.4.0)
@spec retrieve_analytics_rule(rule_name :: String.t(), opts :: 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_rules(opts \\ [])

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

Retrieves all analytics rules

Retrieve the details of all analytics rules

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

(since 0.4.0)
@spec upsert_analytics_rule(
  rule_name :: String.t(),
  body :: OpenApiTypesense.AnalyticsRuleUpsertSchema.t(),
  opts :: keyword()
) ::
  {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Upserts an analytics rule

Upserts an analytics rule with the given name.