ExperimentMetricOutput interface

Package:

@azure-rest/onlineexperimentation

Defines experiment metric metadata and computation details.

Properties

categories	Categories associated with the experiment metric. Used for organizing and filtering metrics.
definition	The metric definition specifying how the metric value is calculated from event data.
description	A detailed description of the experiment metric.
desiredDirection	The desired direction for changes in the metric value. Possible values: "Increase", "Decrease", "Neutral"
displayName	A user-friendly display name for the experiment metric shown in reports and dashboards.
eTag	ETag of the experiment metric.
id	Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
lastModifiedAt	The timestamp (UTC) of the last modification to the experiment metric resource.
lifecycle	Determines whether it is included in experiment analysis. Possible values: "Active", "Inactive"

Property Details

categories

Categories associated with the experiment metric. Used for organizing and filtering metrics.

categories: string[]

Property Value

string[]

definition

The metric definition specifying how the metric value is calculated from event data.

definition: ExperimentMetricDefinitionOutput

Property Value

ExperimentMetricDefinitionOutput

description

A detailed description of the experiment metric.

description: string

Property Value

string

desiredDirection

The desired direction for changes in the metric value.

Possible values: "Increase", "Decrease", "Neutral"

desiredDirection: string

Property Value

string

displayName

A user-friendly display name for the experiment metric shown in reports and dashboards.

displayName: string

Property Value

string

eTag

ETag of the experiment metric.

eTag: string

Property Value

string

id

Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.

id: string

Property Value

string

lastModifiedAt

The timestamp (UTC) of the last modification to the experiment metric resource.

lastModifiedAt: string

Property Value

string

lifecycle

Determines whether it is included in experiment analysis.

Possible values: "Active", "Inactive"

lifecycle: string

Property Value

string