/api/metric

POST /api/metric/{id}/dimension/{dimension-key}

Changed on

Update a metric dimension's display_name, description, default_temporal_unit, and/or source column.

source is a {type, field-id}; the new column must have the same effective type.

post/api/metric/{id}/dimension/{dimension-key}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

dimension-keystring required

value must be a valid UUID.

Request body

default_temporal_unitstring

value must be a non-blank string.

descriptionstring nullable
display_namestring

value must be a non-blank string.

Response

Successful response

object required

Changes