View as Markdown

ChartData

Field	Type	Description
chart_id	bitdrift.public.unary.charts.v1.ChartIdentifier	The chart that this data belongs to.
line_data	bitdrift.public.unary.dashboards.v1.LineChartResponse	Line-chart data for the chart. (Only one of line_data, or treemap_data, pie_data, bar_data, sankey_data, table_data, funnel_data, histogram_bar_chart_response, error can be set)
sankey_data	bitdrift.public.unary.dashboards.v1.SankeyChartResponse	Sankey-chart data for the chart. (Only one of sankey_data, or treemap_data, line_data, pie_data, bar_data, table_data, funnel_data, histogram_bar_chart_response, error can be set)
table_data	bitdrift.public.unary.dashboards.v1.TableChartResponse	Table data for the chart. (Only one of table_data, or treemap_data, line_data, pie_data, bar_data, sankey_data, funnel_data, histogram_bar_chart_response, error can be set)
funnel_data	bitdrift.public.unary.dashboards.v1.FunnelChartResponse	Funnel data for the chart. (Only one of funnel_data, or treemap_data, line_data, pie_data, bar_data, sankey_data, table_data, histogram_bar_chart_response, error can be set)
histogram_bar_chart_response	bitdrift.public.unary.dashboards.v1.HistogramBarChartResponse	Histogram-bar-chart data for the chart. (Only one of histogram_bar_chart_response, or treemap_data, line_data, pie_data, bar_data, sankey_data, table_data, funnel_data, error can be set)
error	string	Returned if there was an error retrieving the data for the chart. The FE should indicate some form of loading error and make this error available in console for debugging. (Only one of error, or treemap_data, line_data, pie_data, bar_data, sankey_data, table_data, funnel_data, histogram_bar_chart_response can be set)

Example

JSON

{
  "chart_id": {
    "workflow": {
      "aggregated_action_id": "actn_ghi789",
      "chart_rule_id": "actn_ghi789",
      "workflow_id": "wrkf_abc123"
    }
  },
  "line_data": {
    "time_series": [
      {
        "aggregated_rollup": 1.0,
        "aggregation_window": "3600s",
        "cardinality_overflows": {
          "group_by_overflows": 1,
          "query_group_by_collapsed": false,
          "total_overflows": 42
        },
        "data": [
          {
            "rate_details": {
              "denominator_count": 42,
              "numerator_count": 42
            },
            "timestamp": "2024-01-15T09:30:00Z",
            "unique_devices": 1,
            "value": 1.0
          }
        ],
        "id": "abc-123-def",
        "labels": [
          {
            "name": "My Workflow",
            "value": "example"
          }
        ],
        "legend": {
          "title": "My Workflow"
        },
        "title": "My Workflow",
        "unique_devices": 1
      }
    ]
  }
}