Admin APIUnstable

Save instance level impact metrics configuration

Enterprise feature

Saves a configuration for an instance level impact metric chart without a feature flag

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

createImpactMetricsConfigSchema
metricNamestringRequired
The Prometheus metric series to query. It includes both unleash prefix and metric type and display name
timeRangeenumRequired
The time range for the metric data.
Allowed values:
yAxisMinenumRequired

Whether the chart should begin at zero on the y-axis.

Allowed values:
aggregationModeenumRequired
The aggregation mode for the metric data.
labelSelectorsmap from strings to lists of stringsRequired
The selected labels and their values for filtering the metric data.
idstringOptional
The unique ULID identifier for this impact metric configuration. Generated automatically if not provided.
titlestringOptional
Optional title for the impact metric chart.

Response

impactMetricsConfigSchema
idstring
The unique ULID identifier for this impact metric configuration. Generated automatically if not provided.
metricNamestring
The Prometheus metric series to query. It includes both unleash prefix and metric type and display name
timeRangeenum
The time range for the metric data.
Allowed values:
aggregationModeenum
The aggregation mode for the metric data.
labelSelectorsmap from strings to lists of strings
The selected labels and their values for filtering the metric data.
typeenum
The type of metric
Allowed values:
displayNamestring
The human readable display name of the impact metric
yAxisMinenum

Whether the chart should begin at zero on the y-axis.

Allowed values:
stepenum or null
The step interval for querying metrics data. This is automatically calculated from the timeRange and stored when the metric is created or updated.
Allowed values:
titlestring or null
Optional title for the impact metric chart.
modeenum or null

The access mode for this impact metric configuration: “read” when referenced by a safeguard, “write” otherwise.

Allowed values: