Skip to main content

CustomDashboardMetric

A registered metric provider version and what it can be combined with

type CustomDashboardMetric {
aggregation: String!
dataset: String!
description: String!
entityGrain: String!
filters: [String!]!
groupings: [[String!]!]!
key: String!
label: String!
maxLimit: Int!
measureLabel: String!
parameters: [CustomDashboardMetricParameter!]!
semantics: String!
timeBasis: String!
unit: String!
version: Int!
visualizations: [CustomDashboardVisualizationRule!]!
}

Fields​

CustomDashboardMetric.aggregation ● String! non-null scalar​

COUNT, MEAN, RATE, PERCENTILE or RATE_CHANGE

CustomDashboardMetric.dataset ● String! non-null scalar​

CustomDashboardMetric.description ● String! non-null scalar​

CustomDashboardMetric.entityGrain ● String! non-null scalar​

Entity counted or measured by this metric

CustomDashboardMetric.filters ● [String!]! non-null scalar​

Widget filter fields this metric accepts

CustomDashboardMetric.groupings ● [[String!]!]! non-null scalar​

Every allowed groupBy dimension list, in order

CustomDashboardMetric.key ● String! non-null scalar​

CustomDashboardMetric.label ● String! non-null scalar​

CustomDashboardMetric.maxLimit ● Int! non-null scalar​

CustomDashboardMetric.measureLabel ● String! non-null scalar​

CustomDashboardMetric.parameters ● [CustomDashboardMetricParameter!]! non-null object​

CustomDashboardMetric.semantics ● String! non-null scalar​

Population and temporal meaning, shown next to the widget

CustomDashboardMetric.timeBasis ● String! non-null scalar​

CustomDashboardMetric.unit ● String! non-null scalar​

CustomDashboardMetric.version ● Int! non-null scalar​

CustomDashboardMetric.visualizations ● [CustomDashboardVisualizationRule!]! non-null object​

Member Of​

CustomDashboardCatalog object

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute