A metric definition defines a metric across multiple components.
| Property Name | Type | Description |
|---|---|---|
| __typename | Literal | |
| derivedEventTypes | Maybe<Array<CompassEventType>> | The event types this metric can be derived from. If undefined, this metric cannot be derived. |
| description | Maybe<String> | The description of the metric definition. |
| format | Maybe<CompassMetricDefinitionFormat> | The format option for applying to the display of metric values. |
| id | String | The unique identifier (ID) of the metric definition. |
| isPinned | Maybe<Boolean> | |
| jqlConfiguration | Maybe<CompassJqlMetricDefinitionConfiguration> | The JQL configuration, if any, for this metric definition. |
| metricSources | Maybe<CompassMetricSourcesQueryResult> | A collection of metrics which contain values that provide numerical data. |
| name | Maybe<String> | The name of the metric definition. |
| type | CompassMetricDefinitionType | The type of the metric definition based on where the definition originated |
| viewerPermissions | Maybe<CompassMetricDefinitionInstancePermissions> | Viewer permissions specific to this metric definition and user context. |
Rate this page: