List the conformed-metric catalogue

GET

/v1/metrics

const url = 'https://api.aerandil.com/v1/metrics';
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://api.aerandil.com/v1/metrics \
  --header 'Authorization: Bearer <token>'

Every registered metric’s presentation surface: name, description, USALI lineage, declared caveats (typed disclosed limits), the unit its scalar carries, measures, dimensions, valid filter keys, grain, version, the rollup table + projection it reads, and the input events it is folded from (the provenance edge). Registry introspection — the values come from the schema, not the database. Query a metric at GET /v1/metrics/{name}.

Authorizations

aerandil_oauth
analytics:read

Responses

200

The metric catalogue, name-sorted.

application/json

object

data

required

Array<object>

object

caveats

Array<object>

object

kind

required

string

note

required

string

description

string

dimensions

required

Array<object>

object

grain

required

string

input_events

Array<string>

measures

required

Array<object>

object

name

required

string

projection_name

string

rollup_table

string

signed

Whether negative values are meaningful — a signed metric (forecast bias) is read against zero, so centre the scale there rather than baselining at zero.

boolean

unit

What the metric’s scalar is, as a display contract. percent is stored as the fraction (0.62, not 62); native_unit means the unit follows a dimension value (metered consumption: kWh / m³ / kg by kind), so a cross-dimension read mixes units.

string

Allowed values: money ratio percent count hours native_unit

usali_reference

string

valid_filters

Array<string>

version

required

integer

Example

{
  "data": [
    {
      "unit": "money"
    }
  ]
}