Skip to content
Omniglass Omniglass Omniglass

Update a metric type

PATCH
/metric-types/{name}
 
curl --request PATCH \
  --url https://example.com/api/v1/metric-types/example \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "label": "example", "precision": 1, "unit": "example" }'

Patches a custom metric type’s label, description, unit, or precision (a nil field is unchanged). Data type is fixed at creation. Official metric types are read-only. Gated by metric_type:update.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The metric type’s name

string

The metric type’s name

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
description

What the series measures

string
label

A human label

string
precision

Decimal places a rendered value keeps

integer format: int64
unit

The display unit of the series

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
data_type
required
string
description
string
id
required

The metric type’s uuid, the stable form the contract and telemetry keys store

string
label
string
name
required
string
official
required
boolean
precision

Decimal places a rendered value keeps

integer format: int64
unit

The display unit of the series (ms, dB, percent)

string
Example 
{
  "$schema": "/api/v1/schemas/MetricTypeBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}