Read one metric series' raw samples

GET

/components/{name}/metrics/{metric}/samples

const url = 'https://example.com/api/v1/components/example/metrics/example/samples';
const options = {method: 'GET'};

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://example.com/api/v1/components/example/metrics/example/samples

The samples behind the effective read’s latest value for one series, newest first, windowed (hours) and capped (limit, newest kept). Gated by component:read; an out-of-scope owner is a non-disclosing 404.

Parameters

Path Parameters

name

required

The owner’s name or uuid

string

The owner’s name or uuid

metric

required

The metric_type name of the series

string

The metric_type name of the series

Query Parameters

hours

The window in hours, counted back from now; 24 when unset

integer format: int64

>= 1 <= 720

The window in hours, counted back from now; 24 when unset

limit

The row cap, newest kept; 500 when unset

integer format: int64

>= 1 <= 2000

The row cap, newest kept; 500 when unset

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

metric

required

The series’ metric_type name

string

owner

required

The owner’s name

string

samples

required

Newest first

Array<object> | null

object

instance

The series discriminator, when set

string

provenance

required

Observed, or calculated for a derived row

string

source

string

required

When the sample was observed

string format: date-time

value

required

number format: double

Example

{
  "$schema": "/api/v1/schemas/MetricSeriesOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}