View Source OpenApiTypesense.Analytics (OpenApiTypesense v0.3.0)
Provides API endpoints related to analytics
Summary
Functions
Create an analytics event
Creates an analytics rule
Delete an analytics rule
Retrieves an analytics rule
Retrieves all analytics rules
Upserts an analytics rule
Functions
@spec create_analytics_event( OpenApiTypesense.AnalyticsEventCreateSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Create an analytics event
Sending events for analytics e.g rank search results based on popularity.
@spec create_analytics_event( OpenApiTypesense.Connection.t(), OpenApiTypesense.AnalyticsEventCreateSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.AnalyticsEventCreateResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec create_analytics_rule( OpenApiTypesense.AnalyticsRuleSchema.t(), 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.
@spec create_analytics_rule( OpenApiTypesense.Connection.t(), OpenApiTypesense.AnalyticsRuleSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@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
@spec delete_analytics_rule(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.AnalyticsRuleDeleteResponse.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@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
@spec retrieve_analytics_rule(OpenApiTypesense.Connection.t(), String.t(), keyword()) :: {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
@spec retrieve_analytics_rules(keyword()) :: {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error
Retrieves all analytics rules
Retrieve the details of all analytics rules
@spec retrieve_analytics_rules( OpenApiTypesense.Connection.t(), keyword() ) :: {:ok, OpenApiTypesense.AnalyticsRulesRetrieveSchema.t()} | :error
@spec upsert_analytics_rule( String.t(), OpenApiTypesense.AnalyticsRuleUpsertSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Upserts an analytics rule
Upserts an analytics rule with the given name.
@spec upsert_analytics_rule( OpenApiTypesense.Connection.t(), String.t(), OpenApiTypesense.AnalyticsRuleUpsertSchema.t(), keyword() ) :: {:ok, OpenApiTypesense.AnalyticsRuleSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}