Overview

This node interacts with the Typesense search platform to create analytics rules. Specifically, the 'Create Analytics Rule' operation allows users to define analytics rules in JSON format, which can be used to monitor and analyze search query patterns and events within a Typesense collection. This is useful for scenarios such as tracking popular queries, no-hit queries, counters, or logs to gain insights into search behavior and improve search relevance.

Use Case Examples

1. Creating an analytics rule to track popular search queries in a specific collection.
2. Defining a no-hit queries rule to identify search terms that return no results, helping to optimize the search index.

Properties

Output

JSON

• name - Name of the created analytics rule.
• type - Type of the analytics rule (e.g., popular_queries, nohits_queries, counter, log).
• collection - The collection to which the analytics rule applies.
• event_type - The event type that the analytics rule monitors.
• id - Unique identifier of the created analytics rule.
• created_at - Timestamp when the analytics rule was created.

Dependencies

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

Troubleshooting

• Ensure the JSON provided in the 'Analytics Rule (JSON)' property is correctly formatted and includes all required fields: name, type, collection, and event_type.
• If the node throws an error about unsupported resources, verify that the resource parameter is set to 'Analytics' and the operation to 'Create Analytics Rule'.
• Errors related to API authentication usually indicate missing or invalid API key credentials; verify the credentials configuration in the node settings.

Links

• Typesense Analytics API Documentation - Official documentation for managing analytics rules in Typesense.