• Home
  • Integrations
  • SDKs
  • Guides
  • API docs
No results for ""
EXPAND ALL

GIVE DOCS FEEDBACK

Metric groups

Read time: 4 minutes
Last edited: Feb 15, 2024

Overview

This topic explains how to create and use metric groups.

Metric groups and experiments

A metric group is a reusable list of metrics you can use to standardize metrics across multiple flags or experiments.

For example, if you have a standard user sign-up flow, you could create four metrics that track customers clicking the sign up button, entering their personal information, adding payment information, and clicking the submit button. By combining these four metrics into a funnel metric group, you can then attach that group to all of your sign-up funnel experiments, ensuring you're tracking the correct metrics for each step within each funnel.

Click on the Metric groups tab to view your metric groups. You can filter the list by group type:

The metric group list.
The metric group list.

There are two types of metric groups:

  • Funnel metric groups are for use with funnel optimization experiments. The order of metrics within funnel metric groups affects how LaunchDarkly measures the metrics. You can include only custom conversion/binary, click, and page view metrics in a funnel metric group. You cannot include custom numeric metrics in a funnel metric group. To learn more, read Creating funnel experiments.
  • Standard metric groups are for use with feature experiments and observing metrics on flag changes. Metrics in standard metric groups can appear in any order. To learn more, read Creating feature change experiments and Release guardian.

You can also use the REST API: List metric groups

The metric group details page

From the Metric groups tab, click on a metric group name to view its details page. The metric group details page lists all the metrics in the group.

The "Metric group connections" section includes information on any experiments or flags the metric group is connected to:

A metric group details page.
A metric group details page.

You can also use the REST API: Get metric group

Create a metric group

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, click, and page view metrics.

To create a metric group:

  1. Navigate to the Metric groups tab from the Metrics list.
  2. Click Create metric group. The "Create metric group" dialog appears.
  3. Enter a Name.
  4. (Optional) Enter a Description.
  5. (Optional) Update the Maintainer.
  6. Select either a "Standard" or a "Funnel" Metric group.
  7. (Optional) If you're 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.
  8. Choose a metric from the Metric menu.
  9. Add a second Step name (optional) and Metric.
  10. (Optional) Click Add metric for each additional metric in your group.
  11. (Optional) For funnel metric groups, drag and drop the steps up or down to reorder them as needed.
  12. Click Create metric group.

You can also use the REST API: Create metric group

Edit a metric group

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 Metric groups tab from the Metrics list.
  2. Click on 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 Submit.

You can also use the REST API: Patch metric group

Delete a metric group

To delete a metric group, navigate to the metric group 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