Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricDefinitionConfig

This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.

Hierarchy

  • MetricDefinitionConfig

Index

Properties

entityIdKey

entityIdKey: string | undefined

The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.

Optional eventPattern

eventPattern: __LazyJsonString | string

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

name

name: string | undefined

A name for the metric.

Optional unitLabel

unitLabel: undefined | string

A label for the units that the metric is measuring.

valueKey

valueKey: string | undefined

The value that is tracked to produce the metric.