Analytics Recipes

Analytics recipes are reusable configurations for analyzing batch test results and comparing decision flow releases. They define what metrics to measure, how to aggregate them, and optionally how to slice the data by dimensions.

What is an Analytics Recipe?

An analytics recipe is a saved configuration that specifies:

• Measures (Slices) - The metrics you want to analyze from your decision output
• Dimensions - Optional grouping criteria for breaking down results
• Aggregations - How to summarize the data (sum, average, count, min, max, quartile, decile)

Once created, you can reuse the same recipe across multiple analyses without reconfiguring the metrics each time.

When to Use Analytics Recipes

Analytics recipes are useful when you:

1. Run batch tests regularly - Save time by reusing the same analysis configuration
2. Compare release revisions - Understand how changes in decision logic affect outcomes
3. Monitor key metrics - Track consistent KPIs across different test runs
4. Perform impact analysis - Measure the effect of rule changes on specific dimensions

Creating an Analytics Recipe

From the Recipes Management Page

1. Navigate to /analysis-recipes in your browser
2. Click "New analysis recipe"
3. Fill in the recipe details:
   • Title - A descriptive name for the recipe
   • Name - A technical identifier (letters, numbers, underscores, hyphens only)
4. Add one or more measures (slices)
5. Save with Ctrl+S or the save button

Recipe Structure

Each recipe contains one or more slices (measures). Each slice defines:

Aggregation Types

Using Analytics Recipes

In Release Analytics

When viewing batch test results for a release:

1. Click "Analyse results" to open the analytics modal
2. Click "From recipe" to expand the recipe selection
3. Select your saved recipe from the dropdown
4. The form automatically populates with the recipe's measures
5. Click "Analyze" to generate charts

Tip: Click the ⚙️ settings icon next to the recipe dropdown to manage recipes in a new tab.

In Impact Analyzer

When comparing revisions using the Impact Analyzer:

1. Open the Impact Analyzer sidebar from any decision component
2. Select a decision flow, dataset, and revisions to compare
3. Choose an Analytics recipe from the dropdown
4. Click "Analyze" to run the comparison

The Impact Analyzer will execute both revisions against the dataset and visualize the differences using your recipe's metrics.

Managing Recipes

Accessing the Management Page

You can access the recipes management page in several ways:

1. Direct URL: Navigate to /analysis-recipes
2. From Analytics Modal: Click the ⚙️ icon next to the recipe dropdown
3. From Impact Analyzer: Click the ⚙️ icon next to the recipe dropdown

Editing a Recipe

1. Go to the recipes list at /analysis-recipes
2. Click on a recipe title to open the edit form
3. Modify the title, name, or measures
4. Save with Ctrl+S or the save button

Deleting a Recipe

1. Go to the recipes list at /analysis-recipes
2. Click the three-dot menu (⋮) next to the recipe
3. Select "Delete"
4. Confirm the deletion

Best Practices

1. Use descriptive names - Make it clear what the recipe analyzes (e.g., "Loan Approval Metrics by Region")

2. Start simple - Begin with 2-3 key metrics, add more as needed

3. Match JSONPaths to your output - Ensure the metric and dimension paths exist in your decision flow output

4. Use dimensions for segmentation - Group by category, region, or status to see patterns

5. Choose appropriate aggregations:

   • Use sum for totals (amounts, counts)
   • Use average for rates and percentages
   • Use decile/quartile for distribution analysis

Example Recipe

Recipe: Loan Decision Analysis

This recipe would generate:

• A chart showing total approved loan amounts
• The overall approval rate as a percentage
• A breakdown of approved amounts by risk level (Low, Medium, High)
• A distribution chart showing how credit scores are spread across deciles