Overview

This node interacts with the Typesense search platform to retrieve analytics rules. Specifically, the 'Get Analytics Rules' operation under the 'Analytics' resource allows users to fetch analytics rules, optionally filtered by a 'rule tag'. This is useful for monitoring and managing search analytics within Typesense, such as tracking search patterns or rule-based analytics configurations.

Use Case Examples

1. A user wants to retrieve all analytics rules to analyze search behavior patterns.
2. A user filters analytics rules by a specific tag to focus on a subset of rules relevant to a particular feature or campaign.

Properties

Output

JSON

• ruleId - Unique identifier of the analytics rule.
• ruleTag - Tag associated with the analytics rule, used for filtering.
• ruleDetails - Details or configuration of the analytics rule.

Dependencies

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

Troubleshooting

• If the resource or operation is not supported, the node throws an error indicating unsupported resource or operation. Ensure the resource is set to 'Analytics' and operation to 'Get Analytics Rules'.
• Errors related to API connectivity or authentication may occur if the Typesense API key credential is missing or invalid. Verify the API key credentials are correctly configured.
• If no rules are returned, check if the optional 'Rule Tag' filter is set correctly or try without the filter to retrieve all rules.

Links

• Typesense Documentation - Official documentation for the Typesense search platform, including analytics and API usage.