Skip to content
WatchTower15Docs

public.customMetrics.view

GET
/custom-metrics/{custom_metric_uuid}
curl --request GET \
  --url https://rest.watchtower15.com/v1/custom-metrics/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
custom_metric_uuid
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

CustomMetricsViewResource

Media typeapplication/json
object
data
required
CustomMetricsViewResource
object
uuid
required
string
name
required
string
description
required

The metric’s description; null for none.

string | null
metric_key
required

The key a publisher sends the metric under.

string
metric_type
required

count sums events per step, level is a gauge.

string
unit
required
string | null
supported_aggregations
required

The aggregations an alarm on this metric may use, from its type.

Array<string>
health_status
required

One of unknown, healthy, warning, critical.

string
last_received_at
required

Epoch milliseconds: when a point last arrived; null if none ever did.

integer | null
active
required

Whether the metric is switched on.

boolean
approved_at
required

Epoch milliseconds: when the organisation accepted it; null while it awaits approval (no points are stored).

integer | null
auto_created
required

Whether it appeared from a push rather than being declared.

boolean
deactivated_at
required

Epoch milliseconds: when it was switched off; null while it is on.

integer | null
max_points_per_day
required

Points accepted a day on the live tier, the limit in force.

integer
max_backfill_points_per_day
required

Points accepted a day on the backfill tier, the limit in force.

integer
backfill_tier_days
required

How many days old a point must be to count against the backfill allowance.

integer
retention_days
required

How many days the samples are kept.

integer
metric_source
required

The source the metric belongs to; null for none.

object
uuid
required
string
name
required
string
tags
required
Array<object>
object
uuid
required
string
name
required
string
created_at
required

Epoch milliseconds.

integer | null
console_url
required

The metric’s page in the console.

string

Example generated

{
  "data": {
    "uuid": "example",
    "name": "example",
    "description": "example",
    "metric_key": "example",
    "metric_type": "example",
    "unit": "example",
    "supported_aggregations": [
      "example"
    ],
    "health_status": "example",
    "last_received_at": 1,
    "active": true,
    "approved_at": 1,
    "auto_created": true,
    "deactivated_at": 1,
    "max_points_per_day": 1,
    "max_backfill_points_per_day": 1,
    "backfill_tier_days": 1,
    "retention_days": 1,
    "metric_source": {
      "uuid": "example",
      "name": "example"
    },
    "tags": [
      {
        "uuid": "example",
        "name": "example"
      }
    ],
    "created_at": 1,
    "console_url": "example"
  }
}

401

Section titled “401”

The API key is missing, malformed, expired or revoked.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

403

Section titled “403”

The key or its owner does not hold what the operation needs.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

404

Section titled “404”

No such record in this organisation (an absent id and another organisation’s answer alike).

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

422

Section titled “422”

The request is invalid; errors names the parameters.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

429

Section titled “429”

A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

500

Section titled “500”

An unexpected error.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}