Metrics API

Contents

• Metrics API

  • Searching Metrics

  • Busy Metrics

  • Invalid Metrics

  • Deleting Metrics

Searching Metrics

Locate Metrics

GET GET /api/v1/metric/search?

Path Parameters

Name	Type	Description
pattern*		[required] metric pattern to search for
only_updated_after	String	To limit search results for metrics that only received data points in the last n hours
only_updated_before	String	To limit search results for metrics that have not received data points in the last n month
with_times	String	To return the first (“created_at”) and last (“last_updated”) seen timestamp for that metric
page	String	Return the nth page of results, for searches that return more than the maximum page size (default maximum size: 100)

200: OK HTTP/1.1 200 Content-Type: application/json { "results": ["foo.bar.1", "foo.bar.2"], "metrics_matched": 2, "total_metrics": 12345, "next_page": 2, }

400: Bad Request Invalid request

Curl examples:

curl -X GET "https://[e-mail]/api/v1/metric/search?pattern=foo.bar.*"

Search for metrics that match the pattern foo.bar.*

curl -X GET "https://[e-mail]/api/v1/metric/search?pattern=*&only_updated_before=30d"

Search for all (*) metrics that have not received data for 30d

Response format for: &with_times=true:

HTTP/1.1 200
Content-Type: application/json

{
  "results": ["foo.bar.1", "foo.bar.2"],
  "metrics_matched": 2,
  "total_metrics": 12345,
  "times": {
    "foo.bar.1": {
      "created_at": 1234567890,
      "last_updated": 1234567890
    },
    "foo.bar.2": {
      "created_at": 1234567890,
      "last_updated": 1234567890
    }
  }
}

---

Busy Metrics

Locate Busy Metrics

GET /api/v1/metric/busy

200: OK HTTP/1.1 200 Content-Type: application/json { "metric": "busy-metric.1", "pct_ratelimited": 60 }

400: Bad Request Invalid request

Curl Example:

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

---

Invalid Metrics

Locate Invalid Metrics

GET /api/v1/metric/invalid

200: OK { "metric": "invalid.character metric\example 1696954420", "reason": "regex", "when": 1696954420, "ip": "xx.xxx.xx.xxx", "protocol": "tcp", "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }

400: Bad Request Invalid request

Curl example:

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

---

Deleting Metrics

Delete Metrics

POST /api/v1/metric/delete

200: OK

400: Bad Request Invalid request

Curl example:

curl -d "pattern=foo.bar.*" "https://[e-mail]/api/v1/metric/delete/"

Delete all metrics that match the pattern foo.bar.*.