No results for ""
EXPAND ALL
  • Home
  • API docs

Creating and managing metric groups

Read time: 2 minutes
Last edited: Sep 30, 2024

Overview

This topic explains how to create and manage metric groups.

Create metric groups

Before you create a metric group, you must create each metric you want to include within the group. To learn how, read Metrics.

Funnel metric groups cannot include custom numeric metrics

Funnel metric groups can include only custom conversion binary, custom conversion count, clicked or tapped, and page viewed metrics.

To create a metric group:

  1. Navigate to the Metrics list, which includes both metrics and metric groups.
  2. Click Create.
  3. Select Create metric group. The "Create metric group" dialog appears.
  4. Enter a Name.
  5. (Optional) Enter a Description.
  6. (Optional) Update the Maintainer.
  7. Select either a "Standard" or a "Funnel" Metric group.
  8. (Optional) If you are creating a funnel metric group, enter the first Step name. If you are creating a standard metric group, you do not need to name the steps.
  9. Choose a metric from the Metric menu.
  10. Add a second Step name (optional) and Metric.
  11. (Optional) Click Add metric for each additional metric in your group.
  12. (Optional) For funnel metric groups, drag and drop the steps up or down to reorder them as needed.
  13. Click Create metric group.

You can also use the REST API: Create metric group

Edit metric groups

You can update an existing metric group's name, description, maintainer, metrics, and, for funnel metric groups, step order.

Click the pencil edit icon next to a metric group's name, maintainer, or description to update it.

To edit a metric group's metrics or step order:

  1. Navigate to the Metrics list, which includes both metrics and metric groups.
  2. Click the name of the metric group you want to edit. The metric group details page opens.
  3. Click Edit metric group.
  4. (Optional) Click + Add metric to add additional metrics to the group.
  5. (Optional) Click the - icon next to an individual metric to remove it. You must have at least two metrics in the metric group.
  6. (Optional) For funnel metric groups, click and hold the grab handle (dotted lines) to drag and drop the existing steps into your desired order.
  7. Click Save metric group.

You can also use the REST API: Patch metric group

Delete metric groups

To delete a metric group, navigate to the metric group's details page and click Delete metric group. Deleting a metric group removes it from all of the environments within the project.

You cannot delete a metric group if it is connected to an experiment or a flag.

You can also use the REST API: Delete a metric group