Classes
Enumerations
Interfaces
TypeAliases

CompassMetricDefinition

A metric definition defines a metric across multiple components.

Property NameTypeDescription
__typenameLiteral
derivedEventTypesMaybe<Array<CompassEventType>>The event types this metric can be derived from. If undefined, this metric cannot be derived.
descriptionMaybe<String>The description of the metric definition.
formatMaybe<CompassMetricDefinitionFormat>The format option for applying to the display of metric values.
idStringThe unique identifier (ID) of the metric definition.
isPinnedMaybe<Boolean>
metricSourcesMaybe<CompassMetricSourcesQueryResult>A collection of metrics which contain values that provide numerical data.
nameMaybe<String>The name of the metric definition.
typeCompassMetricDefinitionTypeThe type of the metric definition based on where the definition originated

Rate this page: