---
search:
exclude: true
---
# ActionRule
An action rule.
| Field | Type | Description |
|---|---|---|
| rule_id | string | ID of this action rule. Must be unique within the workflow. This may be referenced by other APIs and will be documented as such. In special cases it may also be referenced by other actions. For example, a chart and flush action can refer to the rule_id of a measure time action. |
| metric_chart_rule | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration](bitdrift_public_unary_workflows_v1_Rule.md#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration){ title="bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration"} | A metric chart action.
(Only one of metric_chart_rule, or flush_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) |
| flush_rule | [bitdrift.public.unary.workflows.v1.Rule.RuleFlushConfiguration](bitdrift_public_unary_workflows_v1_Rule.md#bitdrift.public.unary.workflows.v1.Rule.RuleFlushConfiguration){ title="bitdrift.public.unary.workflows.v1.Rule.RuleFlushConfiguration"} | A flush action.
(Only one of flush_rule, or metric_chart_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) |
| funnel_rule | [bitdrift.public.unary.workflows.v1.Rule.RuleFunnelConfiguration](bitdrift_public_unary_workflows_v1_Rule.md#bitdrift.public.unary.workflows.v1.Rule.RuleFunnelConfiguration){ title="bitdrift.public.unary.workflows.v1.Rule.RuleFunnelConfiguration"} | A funnel action.
(Only one of funnel_rule, or metric_chart_rule, flush_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) |
| sankey_diagram_rule | [bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration](bitdrift_public_unary_workflows_v1_Rule.md#bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration){ title="bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration"} | A sankey diagram action.
(Only one of sankey_diagram_rule, or metric_chart_rule, flush_rule, funnel_rule, take_screenshot_rule, measure_time_rule, start_tracing_rule can be set) |
| measure_time_rule | [bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime](bitdrift_public_unary_workflows_v1_Rule.md#bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime){ title="bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime"} | A measure time action.
(Only one of measure_time_rule, or metric_chart_rule, flush_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, start_tracing_rule can be set) |
| start_tracing_rule | [bitdrift.public.unary.workflows.v1.RuleStartTracing](bitdrift_public_unary_workflows_v1_RuleStartTracing.md#bitdrift.public.unary.workflows.v1.RuleStartTracing){ title="bitdrift.public.unary.workflows.v1.RuleStartTracing"} | If specified the current session will begin trace sampling.
(Only one of start_tracing_rule, or metric_chart_rule, flush_rule, funnel_rule, sankey_diagram_rule, take_screenshot_rule, measure_time_rule can be set) |
#### Example
```json
{
"metric_chart_rule": {
"time_series": [
{
"aggregated_id": "count/fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"rate": {
"denominator": {
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"name": "field_name"
},
"denominator_id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"group_by": {
"values": [
{
"log_body": false
}
]
},
"numerator": {
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"name": "field_name"
},
"numerator_id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc"
},
"track_unique": {
"device_id": true
}
}
]
},
"rule_id": "_i1yUnHjKfmWpCaD5Tazo"
}
```