highbond_metric (Resource)

Example Usage

resource "highbond_metric" "main" {
  name            = "Example metric"
  table_id        = highbond_table.main.id
  base_color      = "#3F3D3C"
  func            = "uniques"
  interval        = "month"
  metric_type     = "kpi"
  show_sparkline  = true
  view_thresholds = true
  field_name      = "a1"
  time_field_name = "metadata.publish_date"
  force_updates   = true // Create only with force update changes
  config          = <<EOS
  {
    "field_format_map": {},
    "conditional_formats_map": {}
  }
  EOS

  filter_config = <<EOS
  {
    "filtersOpen": false,
    "params": {}
  }
  EOS

  func_argument = ""
}

Schema

Required

• field_name (String) The underlying name of the column in the table used for the metric calculation. field_name must be unique within a table and follow the column naming requirements
• func (String) Defines the aggregate function to use in the metric calculation
• interval (String) Summarizes the metric into a period
• name (String) The name of the metric
• table_id (Number) The ID of the Table
• time_field_name (String) A column in the table with a date, datetime or time data type

Optional

• base_color (String) The name of the metric
• config (String) A JSON string storing the metric format configuration
• filter_config (String) A JSON string storing the metric filter configuration
• force_updates (Boolean) Allows overriding top-level 'create_only' option.
• func_argument (String) A JSON string storing the arguments of the Metric function
• metric_type (String) Tags the metric as an indicator type, such as a key performance indicator or key risk indicator
• show_sparkline (Boolean) Shows (true) or hides (false) the trend of key indicator performance from the earliest calculation period to the current period for users that view the metric
• view_thresholds (Boolean) Shows (true) or hides (false) active trigger thresholds on the sparkline

Read-Only

• created_at (String) The date the metric was created
• id (String) The ID of this resource.
• updated_at (String) The date the metric was updated