View as Markdown

ChartRequest

Field	Type	Description
chart_id	bitdrift.public.unary.charts.v1.ChartIdentifier	The identifier of the chart to fetch data for.
histogram_configuration	bitdrift.public.unary.charts.v1.HistogramConfiguration	Optional configuration for any histogram values within the chart.
insight_comparison_configuration	bitdrift.public.unary.dashboards.v1.InsightComparisonConfiguration	Optional configuration to indicate that this chart should compare two insights time series.
top_k_configuration	bitdrift.public.unary.dashboards.v1.TopKConfiguration	Optional configuration for the top K grouping to use for this chart.
limit_strategy	bitdrift.public.unary.charts.v1.LimitStrategy	Optional limit strategy to use for this chart. Currently only supported for line charts. If this is omitted, a default value of limiting by a top k of 5 entries is used.
sankey_configuration	bitdrift.public.unary.dashboards.v1.SankeyConfiguration	Optional configuration for the sankey chart.
counter_configuration	bitdrift.public.unary.dashboards.v1.CounterConfiguration	Counter configuration for the chart. Currently this is only used for resolving which table type to show in the case of a group by query.
rate_configuration	bitdrift.public.unary.dashboards.v1.RateConfiguration	Rate configuration for the chart. Currently this is only used for resolving which table type to show in the case of a group by query.
time_series_display_mode	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode	(Only one of time_series_display_mode, or table_display_mode, histogram_bar_chart_display_mode can be set)
table_display_mode	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TableDisplayMode	(Only one of table_display_mode, or time_series_display_mode, histogram_bar_chart_display_mode can be set)
histogram_bar_chart_display_mode	bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode	This is only valid if all time series in the chart are histograms. (Only one of histogram_bar_chart_display_mode, or time_series_display_mode, table_display_mode can be set)

Example

JSON

{
  "chart_id": {
    "workflow": {
      "aggregated_action_id": "actn_ghi789",
      "chart_rule_id": "actn_ghi789",
      "workflow_id": "wrkf_abc123"
    }
  },
  "counter_configuration": {
    "aggregation_type": "SUM"
  },
  "histogram_configuration": {
    "percentile": 1.0,
    "percentiles": [
      1.0
    ]
  },
  "insight_comparison_configuration": {
    "lhs_id": "abc-123-def",
    "rhs_id": "abc-123-def"
  },
  "limit_strategy": {},
  "rate_configuration": {
    "aggregation_type": "AVG"
  },
  "sankey_configuration": {
    "compaction_target": 1,
    "top_k_paths": 1
  },
  "time_series_display_mode": {},
  "top_k_configuration": {
    "algorithm_name": "My Workflow"
  }
}