DatasetField

One field a dataset exposes.

type DatasetField {
  aggregation: String
  description: String
  formula: String
  group: String
  key: String!
  label: String!
  role: DatasetFieldRole!
  semantic: String
  type: DatasetFieldType!
}

Fields

DatasetField.aggregation ● String scalar

Default aggregation for a metric: SUM, COUNT, AVG, MIN, MAX or NONE.

DatasetField.description ● String scalar

DatasetField.formula ● String scalar

For derived metrics such as rates, the expression to compute them from other fields — for example "SUM(opens) / SUM(sends)". Derived fields are never returned as data: a stored ratio cannot be re-aggregated, so a consumer that rolled rows up would display a wrong number. Compute it from this instead.

DatasetField.group ● String scalar

Fields sharing a group are presented together.

DatasetField.key ● String! non-null scalar

Stable identifier used when requesting this field. Does not change once published.

DatasetField.label ● String! non-null scalar

Human-readable name.

DatasetField.role ● DatasetFieldRole! non-null enum

DatasetField.semantic ● String scalar

Hint describing what the value means, for consumers that adapt their formatting to it — for example YEAR_MONTH_DAY, YEAR_MONTH, PERCENT.

DatasetField.type ● DatasetFieldType! non-null enum

Member Of

Dataset object ● DatasetRowsResponse object