Class ExperimentsMetricV2DTODataAttributes

Details of the metric.

Hierarchy

  • ExperimentsMetricV2DTODataAttributes

Constructors

constructor

Properties

additionalProperties? certifiedAt? createdAt? dataSourceType? denominatorAggregation? description? desiredChange? experimentCount? formatAsPercent? guardrailCutoffThreshold? metricType? migrationMetadata? name? numeratorAggregation? percentileAggregation? referenceUrl? updatedAt?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional certifiedAt

certifiedAt?: Date

Time when this resource was certified.

Optional createdAt

createdAt?: Date

Time when this resource was created.

Optional dataSourceType

dataSourceType?: ExperimentsMetricV2DTODataAttributesDataSourceType

Source of the data used to calculate the metric.

Optional denominatorAggregation

denominatorAggregation?: ExperimentsMetricV2DTODataAttributesNumeratorAggregation

Source measure and aggregation settings for a metric value.

Optional description

description?: string

Text that explains the metric.

Optional desiredChange

desiredChange?: ExperimentsMetricV2DTODataAttributesDesiredChange

Direction of metric change considered desirable.

Optional experimentCount

experimentCount?: number

Number of experiments that reference this resource.

Optional formatAsPercent

formatAsPercent?: boolean

Whether to display the metric value as a percentage.

Optional guardrailCutoffThreshold

guardrailCutoffThreshold?: number

Threshold used when evaluating this metric as a guardrail.

Optional metricType

metricType?: ExperimentsMetricV2DTODataAttributesMetricType

Type of metric calculation.

Optional migrationMetadata

migrationMetadata?: any

Metadata retained for resources imported from another system.

Optional name

name?: string

Display name of the metric.

Optional numeratorAggregation

numeratorAggregation?: ExperimentsMetricV2DTODataAttributesNumeratorAggregation

Source measure and aggregation settings for a metric value.

Optional percentileAggregation

percentileAggregation?: ExperimentsMetricV2DTODataAttributesPercentileAggregation

Source measure and settings for a percentile metric.

Optional referenceUrl

referenceUrl?: string

URL with supporting information about the metric.

Optional updatedAt

updatedAt?: Date

Time when this resource was last updated.

Settings

Member Visibility

Theme

Generated using TypeDoc