data

Return catalog of queryable metric types

Returns a list of Fulcra Metrics that can be queried.

get/data/v0/metrics_catalog

Request

  • Base URL: https://api.fulcradynamics.com
  • URL: https://api.fulcradynamics.com/data/v0/metrics_catalog
  • Auth: HTTP bearer

Response

Successful Response

descriptionstring required

A human-readable description of the metric.

is_time_seriesboolean

This is true when the metric is a time-series metric.

metric_kindstring nullable

The kind of metric.

namestring required

The name of the metric.

unitstring required

The measurement unit of the value column.

value_columnstring required

The name of the value column in the resulting dataframe.

Changes

No recorded changes to this operation across all 1 revision of this API.