Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Path Parameters
id
Body
The name of the metric, serving as its primary identifier.
"metricName"
A detailed description of the metric, providing insights into its purpose and application.
An array of tags associated with the metric, used for categorization and easier retrieval.
Flag to mark the metric as verified, ensuring it is deemed trustworthy within the organization.
Specifies if the metric definition can only be edited via the Console API, enhancing control over modifications.
Determines if the metric is permanent, preventing it from being deleted or modified inadvertently.
Optional configuration for metrics utilizing Warehouse Native features, defining specific behaviors and criteria.
Array of unit types that the metric can utilize, such as stableID, userID, or other custom identifiers.
Optional field indicating the team name responsible for the metric, aiding in accountability and management.
Optional field indicating the team ID responsible for the metric, aiding in accountability and management.
Indicates the desired change direction for the metric. Use "increase" for positive changes and "decrease" for negative changes.
increase
, decrease
"increase"
Skips persisting updates to the metric (used to validate that inputs are correct)