Tag API

Contents

• Tag API

  • Listing All Tags

  • Search Tagged Metrics

  • Deleting Tagged Metrics

  • Monitoring your Tagged Metrics usage

Listing All Tags

List all tags

GET GET /api/v1/tags

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

Curl example:

curl -X GET "https://[e-mail]/api/v1/tags"

---

Search Tagged Metrics

Locate a Tag's Values

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

200: OK

400: Bad Request

501: Not Implemented

Curl example:

curl -X GET "https://[e-mail]/api/v1/tags/host?filter=prod-00*&limit=3"

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.

200: OK HTTP/1.1 200 Content-Type: application/json ["0.queue_backlog;cluster=prod;host=prod-egg-0021;process=grind;service=data_process", "2.queue_backlog;cluster=prod;host=prod-egg-0021;process=grind;service=data_process", "0.items;cluster=prod;host=prod-egg-001;process=dump;service=data_process"]

400: Bad Request

500: Internal Server Error

Curl examples:

curl -X GET "https://[e-mail]/api/v1/tags/findSeries?expr=cluster=prod&host=egg-0001"

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

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

HTTP/1.1 200
Content-Type: application/json

{"tag": "host",
 "values": [{"count": 59, "value": "machine-0001"},
            {"count": 57, "value": "machine-0002"},
            {"count": 59, "value": "machine-0003"}]
}

---

Deleting Tagged Metrics

Delete Tagged Metricss

POST /api/v1/tags/delSeries

200: OK

400: Bad Request

Curl example:

curl -X POST "https://[e-mail]/api/v1/tags/delSeries" --data-urlencode "path=foo.bar;tag1=val1;tag2=val2"

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