View as Markdown

ChartIdentifier¶

Field	Type	Description
workflow	bitdrift.public.unary.charts.v1.ChartIdentifier.WorkflowChart	A workflow-backed metric chart. (Only one of workflow, or workflow_tree_map, sankey_chart, active_devices_chart, workflow_funnel_chart, workflow_session_capture_chart, issue_stability_chart can be set)
workflow_tree_map	bitdrift.public.unary.charts.v1.ChartIdentifier.WorkflowTreeMapChart	A workflow-backed tree map chart. (Only one of workflow_tree_map, or workflow, sankey_chart, active_devices_chart, workflow_funnel_chart, workflow_session_capture_chart, issue_stability_chart can be set)
sankey_chart	bitdrift.public.unary.charts.v1.ChartIdentifier.WorkflowSankeyChart	A workflow-backed sankey chart. (Only one of sankey_chart, or workflow, workflow_tree_map, active_devices_chart, workflow_funnel_chart, workflow_session_capture_chart, issue_stability_chart can be set)
active_devices_chart	bitdrift.public.unary.charts.v1.ChartIdentifier.ActiveDevicesChart	An active-devices chart. (Only one of active_devices_chart, or workflow, workflow_tree_map, sankey_chart, workflow_funnel_chart, workflow_session_capture_chart, issue_stability_chart can be set)
workflow_funnel_chart	bitdrift.public.unary.charts.v1.ChartIdentifier.WorkflowFunnelChart	A workflow-backed funnel chart. (Only one of workflow_funnel_chart, or workflow, workflow_tree_map, sankey_chart, active_devices_chart, workflow_session_capture_chart, issue_stability_chart can be set)
workflow_session_capture_chart	bitdrift.public.unary.charts.v1.ChartIdentifier.WorkflowSessionCaptureChart	A workflow-backed session capture chart. (Only one of workflow_session_capture_chart, or workflow, workflow_tree_map, sankey_chart, active_devices_chart, workflow_funnel_chart, issue_stability_chart can be set)
issue_stability_chart	bitdrift.public.unary.charts.v1.ChartIdentifier.IssueStabilityChart	An issue-stability chart. (Only one of issue_stability_chart, or workflow, workflow_tree_map, sankey_chart, active_devices_chart, workflow_funnel_chart, workflow_session_capture_chart can be set)

Example¶

JSON

{
  "workflow": {
    "aggregated_action_id": "actn_ghi789",
    "chart_rule_id": "actn_ghi789",
    "workflow_id": "wrkf_abc123"
  }
}

ChartIdentifier.WorkflowChart¶

Field	Type	Description
workflow_id	string	The workflow that owns this chart.
chart_rule_id	string	The ID of the rule node within the workflow that holds the RuleChartConfiguration for this chart.
aggregated_action_id	optional string	Optional aggregated action ID to further resolve the chart to a specific time series. Currently this is only used (and required) when the FE is fetching example cardinality for a specific time series. In the future it might be used to filter the chart to a specific time series for generic display if desired when sent in the data request.

Example¶

JSON

{
  "aggregated_action_id": "actn_ghi789",
  "chart_rule_id": "actn_ghi789",
  "workflow_id": "wrkf_abc123"
}

ChartIdentifier.WorkflowFunnelChart¶

Field	Type	Description
workflow_id	string	The workflow that owns this funnel chart.
funnel_rule_id	string	The funnel rule that defines this chart.

Example¶

JSON

{
  "funnel_rule_id": "actn_ghi789",
  "workflow_id": "wrkf_abc123"
}

ChartIdentifier.WorkflowSessionCaptureChart¶

Field	Type	Description
workflow_id	string	The workflow that owns this session capture chart.
flush_rule_id	string	The flush rule that defines the session capture chart.
action_id	string	The action whose captured sessions should be returned.

Example¶

JSON

{
  "action_id": "actn_ghi789",
  "flush_rule_id": "actn_ghi789",
  "workflow_id": "wrkf_abc123"
}

ChartIdentifier.WorkflowTreeMapChart¶

Field	Type	Description
workflow_id	string	The workflow that owns this tree map chart.
size_chart_rule_id	string	The ID of the rule node within the workflow that holds the line chart to be used to size the chart. This rule must contain a single counter chart with a group by.
color_chart_rule_id	string	The ID of the rule node within the workflow that holds the line chart to be used to color the chart. This rule must contain a single counter chart with a group by.

Example¶

JSON

{
  "color_chart_rule_id": "actn_ghi789",
  "size_chart_rule_id": "actn_ghi789",
  "workflow_id": "wrkf_abc123"
}

ChartIdentifier.WorkflowSankeyChart¶

Field	Type	Description
workflow_id	string	The workflow that owns this sankey chart.
rule_id	string	The rule that defines this sankey chart.

Example¶

JSON

{
  "rule_id": "actn_ghi789",
  "workflow_id": "wrkf_abc123"
}

ChartIdentifier.ActiveDevicesChart¶

Currently active devices are global to a shard and thus not tied to any action ID. Filtering is provided via the charts request and no other dimensionality is supported. The data response will use LineChartResponse and the dashboard definition will be of type Line.

Field	Type	Description
type	bitdrift.public.unary.charts.v1.ChartIdentifier.ActiveDevicesChart.ActiveDevicesChartType	The active-devices chart variant to query.

Example¶

JSON

{
  "type": "NORMAL"
}

ChartIdentifier.ActiveDevicesChart.ActiveDevicesChartType¶

Name	Number	Description
NORMAL	0	This is a standard chart using 1m/15m/2h resolutions.
LONG_TERM	1	Similar to ActiveDevicesChart but will include 3 series, with each data point being a day: 1) DAU (active devices for that day) 2) WAU (rolling active devices for the last 7 days) 3) MAU (rolling active devices for the last 30 days) This will be sent in a dashboard group with a minimum query interval of 7 days. If pinned, and the user selects a smaller time window there just won't be any data or we can potentially hide or give special treatment.
STICKINESS	2	Similar to ActiveDevicesChart but will show a % which equates to DAU/MAU with similar time range restrictions.

ChartIdentifier.IssueStabilityChart¶

Similar to a ActiveDevicesChart, shows issue stability info that is not tied to any specific action ID. All are filtered by platform and app ID.

Field	Type	Description
type	bitdrift.public.unary.charts.v1.ChartIdentifier.IssueStabilityChart.IssueStabilityChartType	The issue-stability chart variant to query.

Example¶

JSON

{
  "type": "GLOBAL"
}

ChartIdentifier.IssueStabilityChart.IssueStabilityChartType¶

Name	Number	Description
GLOBAL	0	Shows 3 series on the same chart: Crash-Free Rate: (1 - (# of crashes / # of app opens)) x 100 Crash-Free Session Rate: (1 - (# of crash sessions / # of sessions)) x 100 Crash-Free Devices: (1 - (# of crashed devices / # of devices)) x 100
DETAILED_CRASH_FREE_RATE	1	Crash-Free Rate grouped by report type.
DETAILED_CRASH_FREE_SESSION_RATE	2	Crash-Free Session Rate grouped by report type.
DETAILED_CRASH_FREE_DEVICES	3	Crash-Free Devices grouped by report type.