Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Analytics → Update Analytics Rule

AI-generated

Overview

This node interacts with the Typesense search platform, specifically supporting operations related to analytics rules. The 'Update Analytics Rule' operation allows users to update an existing analytics rule by providing the rule's name and the rule definition in JSON format. This is useful for managing and refining analytics rules that monitor search queries and events within a Typesense collection, such as popular queries, no-hit queries, counters, or logs.

Use Case Examples

  1. Updating an analytics rule to change the monitored event type or collection.
  2. Modifying the JSON definition of an existing analytics rule to adjust its parameters or behavior.

Properties

Name Meaning
Rule Name The name of the analytics rule to update. This identifies which rule will be modified.
Analytics Rule (JSON) The JSON representation of the analytics rule, including required fields such as name, type (e.g., popular_queries, nohits_queries, counter, log), collection, and event_type. This JSON defines the updated rule configuration.

Output

JSON

  • updatedRule - The updated analytics rule object as returned by the Typesense API after the update operation.

Dependencies

  • Requires an API key credential for authenticating with the Typesense search platform.

Troubleshooting

  • Ensure the 'Rule Name' matches an existing analytics rule; otherwise, the update will fail.
  • The 'Analytics Rule (JSON)' must be valid JSON and include all required fields (name, type, collection, event_type) to avoid validation errors.
  • API authentication errors may occur if the Typesense API key credential is missing or invalid.

Links

Discussion