For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tag API

Contents

Listing All Tags

GET GET /api/v1/tags

HTTP/1.1 200
Content-Type: application/json
[
  "cluster",
  "host",
  "process",
  "service",
  "name"
]

Bad Request

Curl example:


Search Tagged Metrics

GET GET /api/v1/tags/<tagname>

Path Parameters

Name
Type
Description

expr

String

To search for the tagged series that match the expression, users should include both tagname and value in the query

filter

String

Tag value to search for

limit

String

To limit the number of search results to the given number

OK

Bad Request

Not Implemented

Curl example:

Search for tag name host that matches the value prod, and only show 3 matching results.

Locate Tagged Metrics and Values

GET /api/v1/tags/findSeries?

Path Parameters

Name
Type
Description

expr

String

Format: expr=tagname=tagvalue or expr=tagname1=tagvalue1&tagname2=tagvalue2 To search for the tagged series that match the expression, users should include both tagname and value in the query.

filter

String

Format: filter=prod-00* Tag value to search for.

limit

String

Format: limit=3 To limit the number of search results to the given number.

Bad Request

Internal Server Error

Curl examples:

Search for tagged metric/series that match the expression cluster=prod&host=egg-0001

Response format with ‘?filter=machine-000*&limit=3’:


Deleting Tagged Metrics

POST /api/v1/tags/delSeries

OK

Bad Request

Curl example:

Delete all series that match the path foo.bar and tag1=val1 and tag2=val2.


Monitoring your Tagged Metrics usage

If you have sent tagged metrics then the number of tagged metrics you have sent will be displayed when you hover over the metric count on your Homepage:

Total Tags in Account

You can also locate, search, and delete your tagged metrics from within our Tag Search UI:

Tag Search UI

Last updated