Interface MetricDataReference

References where the data for a particular metric can be retrieved from.

When adding a new source for metric data you will implement a MetricDataProvider that can do the actual fetching of data and then when you define your metrics you'll use MetricDataReferences that reference that provider and identify the specific data being referenced (e.g. a csv column or API path).

Example

dataReference: {
providerId: "mock",
minValue: 0,
maxValue: 100,
startDate: "2022-01-02",
endDate: "2022-06-01",
},

Hierarchy

  • MetricDataReference

Indexable

[key: string]: unknown

Properties

Properties

providerId: string

The id of a registered MetricDataProvider that will be used to fetch data for this metric (e.g. "main-metrics-csv" or "city-data-api").

Generated using TypeDoc