public.customMetrics.series
const url = 'https://rest.watchtower15.com/v1/custom-metrics/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/series';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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/series \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”A relative window ending now: 1 to 9999 minutes, hours, days or weeks (3h, 2w). Not with from and to. The operation names its longest window and its default.
The start of a pinned window, epoch milliseconds or RFC 3339 with an offset. Needs to. A start before the oldest data kept is served from it.
The end of a pinned window, epoch milliseconds or RFC 3339 with an offset, after from. A window that ends before the oldest data kept, or in the future, is refused.
Responses
Section titled “Responses”CustomMetricsSeriesResource
object
object
Whether the metric has data to chart: false while it awaits approval.
awaiting_approval while available is false; null otherwise.
object
count or level.
object
Epoch milliseconds: the start of the window asked for; the first point can be one step earlier.
Epoch milliseconds.
Always custom: the custom metrics store.
The width of one step in seconds: a point is the aggregate of a step.
One series for an approved metric, none while it awaits approval.
object
The metric’s key.
The metric’s unit.
object
Always null on a custom series.
Always null on a custom series.
Always null on a custom series.
Always null on a custom series.
Always null on a custom series.
count_per_step (a count metric, summed per step) or value_per_step (a level metric).
[t, value] pairs, t epoch milliseconds.
Example generated
{ "data": { "available": true, "reason": "example", "metric": { "uuid": "example", "name": "example", "metric_key": "example", "metric_type": "example", "unit": "example" }, "window": { "from": 1, "to": 1 }, "source": "example", "step_seconds": 1, "series": [ { "name": "example", "unit": "example", "labels": { "mount": "example", "device": "example", "interface": "example", "state": "example", "cpu": "example" }, "point_meaning": "example", "points": [ [ 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}A data store did not answer within the request’s 10 seconds; try again shortly (store_unavailable).
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}