public.customMetrics.list
const url = 'https://rest.watchtower15.com/v1/custom-metrics?sort=name&direction=asc&include_total=true';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://rest.watchtower15.com/v1/custom-metrics?sort=name&direction=asc&include_total=true' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”CustomMetricsListResource
object
object
The key a publisher sends the metric under.
count sums events per step, level is a gauge.
One of unknown, healthy, warning, critical.
Epoch milliseconds: when a point last arrived; null if none ever did.
Whether the metric is switched on.
Epoch milliseconds: when the organisation accepted it; null while it awaits approval (no points are stored).
Whether it appeared from a push rather than being declared.
The source the metric belongs to; null for none.
object
object
The metric’s page in the console.
The whole list’s size; present only with include_total=true.
Example generated
{ "data": [ { "uuid": "example", "name": "example", "metric_key": "example", "metric_type": "example", "unit": "example", "health_status": "example", "last_received_at": 1, "active": true, "approved_at": 1, "auto_created": true, "metric_source": { "uuid": "example", "name": "example" }, "tags": [ { "uuid": "example", "name": "example" } ], "console_url": "example" } ], "next_cursor": "example", "total": 1}The API key is missing, malformed, expired or revoked.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}The key or its owner does not hold what the operation needs.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}No such record in this organisation (an absent id and another organisation’s answer alike).
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}The request is invalid; errors names the parameters.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}An unexpected error.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}