v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Metrics

Update a tag configuration

Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations of a count, rate, or gauge metric. By setting exclude_tags_mode to true the behavior is changed from an allow-list to a deny-list, and tags in the defined list will not be queryable. Can only be used with application keys from users with the Manage Tags for Metrics permission. This endpoint requires a tag configuration to be created first.

patch/api/v2/metrics/{metric_name}/tags

Path parameters

metric_namestring required

The name of the metric.

Request body

Example request

{
  "data": {
    "attributes": {
      "group_by": [
        "app",
        "datacenter"
      ],
      "include_percentiles": false
    },
    "id": "http.endpoint.request",
    "type": "manage_tags"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "aggregations": [
        {
          "space": "avg",
          "time": "avg"
        }
      ],
      "created_at": "2020-03-25T09:48:37.463835Z",
      "metric_type": "gauge",
      "modified_at": "2020-04-25T09:48:37.463835Z",
      "tags": [
        "app",
        "datacenter"
      ]
    },
    "id": "http.request.latency",
    "type": "manage_tags"
  }
}