# Rule
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1332-L1601`]()
No fields
# Rule.RuleFlushConfiguration
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1333-L1343`]()
| Field | Type | Description |
|---|---|---|
| id | string
up to 100 chars; server generated | The server-generated ID for this rule action. This can be used to query for sessions that arrive at this rule action. |
| applied_daily_limit | uint32
server generated | The effective daily capture limit currently applied to this rule. |
| match_id | string
up to 100 chars | The match ID of the step that triggers session capture. |
Example
```json
{
"applied_daily_limit": 25,
"id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"match_id": "_i1yUnHjKfmWpCaD5Tazo"
}
```
# Rule.RuleMetricChartConfiguration
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1347-L1486`]()
A metrics action defines one or more time series that are computed from workflow matches and
emitted with the metadata needed to combine them into a chart server-side.
| Field | Type | Description |
|---|---|---|
| time_series | array of [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries")
up to 100 items | The time series that should be generated for this chart. |
Example
```json
{
"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.RuleMetricChartConfiguration.DataReference
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1349-L1364`]()
A reference to the match ID and field extraction that provides the value for a single time series.
| Field | Type | Description |
|---|---|---|
| match_id | string
up to 100 chars | The match ID that provides the value for this data reference. If extraction type is `measured_time`, this must point to a Measure Time rule. |
| name | string
up to 100 charsonly one of name, or measured_time can be set | The name of the field to extract the value from. |
| measured_time | boolonly one of measured_time, or name can be set | Extract the measured time from a completed Measure Time rule. This can only be set if the match_id points to a Measure Time rule. |
Example
```json
{
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"name": "field_name"
}
```
# Rule.RuleMetricChartConfiguration.TimeSeries
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1366-L1482`]()
| Field | Type | Description |
|---|---|---|
| rate | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Rate](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Rate "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Rate")only one of rate, or histogram, count, average_count can be set | Emits a numerator and denominator and renders their ratio as a percentage-based time series. |
| histogram | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Histogram](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Histogram "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Histogram")only one of histogram, or rate, count, average_count can be set | Records numeric samples and renders percentile lines such as P50, P90, and P99. |
| count | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Count](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Count "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.Count")only one of count, or rate, histogram, average_count can be set | Emits counts for matching events or extracted values. |
| average_count | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.AverageCount](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.AverageCount "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.AverageCount")only one of average_count, or rate, histogram, count can be set | Emits an average based on a numerator series and an implicit denominator count. |
| aggregated_id | string
up to 100 chars; server generated | This is the normalized ID for the time series. It is the ID that ends up being used in chart data requests, attaching alerts, etc. |
| track_unique | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.TrackUnique](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.TrackUnique "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.TimeSeries.TrackUnique") | Whether to track unique contributions to each aggregation interval for this time series. |
Example
```json
{
"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.RuleMetricChartConfiguration.TimeSeries.Rate
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1370-L1390`]()
A rate metric that is going to be generated for this time series. This
is done by emitting simple counters for each of the extracted values
and computing the ratio server-side.
| Field | Type | Description |
|---|---|---|
| numerator | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference") | The data reference to use for the rate numerator. |
| denominator | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference") | The data reference to use for the rate denominator. |
| numerator_id | string
up to 100 chars; server generated | The server-generated ID for this rate metric. This can be used to query for the metric. |
| denominator_id | string
up to 100 chars; server generated | The server-generated ID for the denominator metric. This can be used to query for the metric. |
| group_by | [bitdrift.public.unary.workflows.v1.GroupBy](bitdrift_public_unary_workflows_v1_GroupBy.md "bitdrift.public.unary.workflows.v1.GroupBy") | An optional group by configuration for the time series. The chart will select a limited number of time series based on a top K lookup of the most relevant time series. If the group by is not set, the generated chart will show the time series as a single line. |
Example
```json
{
"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"
}
```
# Rule.RuleMetricChartConfiguration.TimeSeries.Histogram
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1395-L1409`]()
A histogram metric that is going to be generated for this time series.
This is done by emitting histogram values for each value of the
extracted value, aggregated server-side.
| Field | Type | Description |
|---|---|---|
| value | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference") | The data reference whose values will be recorded in the histogram. |
| group_by | [bitdrift.public.unary.workflows.v1.GroupBy](bitdrift_public_unary_workflows_v1_GroupBy.md "bitdrift.public.unary.workflows.v1.GroupBy") | An optional group by configuration for the time series. The chart will select a limited number of time series based on a top K lookup of the most relevant time series. If the group by is not set, the generated chart will show the time series with one line per (P50, P90, P99) percentile. |
| id | string
up to 100 chars; server generated | The server-generated ID for this histogram metric. This can be used to query for the metric. |
Example
```json
{
"group_by": {
"values": [
{
"log_body": false
}
]
},
"id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"value": {
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"name": "field_name"
}
}
```
# Rule.RuleMetricChartConfiguration.TimeSeries.Count
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1413-L1426`]()
A count metric that is going to be generated for this time series. This
is done by emitting a counter with the extracted value.
| Field | Type | Description |
|---|---|---|
| value | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference") | The data reference whose values will be emitted into the counter. |
| group_by | [bitdrift.public.unary.workflows.v1.GroupBy](bitdrift_public_unary_workflows_v1_GroupBy.md "bitdrift.public.unary.workflows.v1.GroupBy") | An optional group by configuration for the time series. The chart will select a limited number of time series based on a top K lookup of the most relevant time series. If the group by is not set, the generated chart will show the time series as a single line. |
| id | string
up to 100 chars; server generated | The server-generated ID for this count metric. This can be used to query for the metric. |
Example
```json
{
"group_by": {
"values": [
{
"log_body": false
}
]
},
"id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"value": {
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"name": "field_name"
}
}
```
# Rule.RuleMetricChartConfiguration.TimeSeries.AverageCount
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1432-L1449`]()
This time series type will produce an average counter, by emitting a synthetic denominator
counter increment every time the numerator counter is extracted and incremented. In
practice this is identical to rate, but the display will not be % based and the denominator
is implicit.
| Field | Type | Description |
|---|---|---|
| numerator | [bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference](#bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference "bitdrift.public.unary.workflows.v1.Rule.RuleMetricChartConfiguration.DataReference") | The data reference to use for the average count numerator. |
| numerator_id | string
up to 100 chars; server generated | The server-generated ID for this rate metric. This can be used to query for the metric. |
| denominator_id | string
up to 100 chars; server generated | The server-generated ID for the denominator metric. This can be used to query for the metric. |
| group_by | [bitdrift.public.unary.workflows.v1.GroupBy](bitdrift_public_unary_workflows_v1_GroupBy.md "bitdrift.public.unary.workflows.v1.GroupBy") | An optional group by configuration for the time series. The chart will select a limited number of time series based on a top K lookup of the most relevant time series. If the group by is not set, the generated chart will show the time series as a single line. |
Example
```json
{
"denominator_id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"group_by": {
"values": [
{
"log_body": false
}
]
},
"numerator": {
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"name": "field_name"
},
"numerator_id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc"
}
```
# Rule.RuleMetricChartConfiguration.TimeSeries.TrackUnique
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1451-L1457`]()
| Field | Type | Description |
|---|---|---|
| device_id | bool | This is computed entirely server-side and thus does not require any client emission. |
Example
```json
{
"device_id": true
}
```
# Rule.RuleSankeyDiagramConfiguration
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1490-L1531`]()
A Sankey diagram action combines multiple steps in a single flow user journey into a single
diagram that shows which paths are taken through the flow.
| Field | Type | Description |
|---|---|---|
| nodes | array of [bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration.Node](#bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration.Node "bitdrift.public.unary.workflows.v1.Rule.RuleSankeyDiagramConfiguration.Node")
up to 100 items | The list of nodes. Since workflows can have loops and each node corresponds to a matcher within a workflow, it's possible for a given matcher and its corresponding node to be visited multiple times. For each visit, a new value is extracted. Additional details related to each node of the diagram. This data is not modified by the server during workflow updates, allowing the frontend to store information that remains stable between updates. All target nodes must be within the same flow. The loop section is the portion of the flow covered by a loop back-edge; nodes in that section are treated as extracted dynamic values, while nodes before or after it are fixed labels. |
| id | string
up to 100 chars; server generated | The server-generated ID for this rule action. This uniquely identifies the Sankey diagram in a way which is consistent between workflows that define the same Sankey diagram. |
Example
```json
{
"id": "fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc",
"nodes": [
{
"extract_field": "field_name",
"id": "_i1yUnHjKfmWpCaD5Tazo"
}
]
}
```
# Rule.RuleSankeyDiagramConfiguration.Node
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1493-L1513`]()
Each node corresponds to a match rule in the flow and supplies the value recorded when that
node is visited.
| Field | Type | Description |
|---|---|---|
| id | string
between 1 and 100 chars | ID of the corresponding match rule. It must resolve to a known match ID, and all node IDs in a single Sankey diagram must belong to the same flow. |
| fixed | string
up to 255 charsonly one of fixed, or extract_field can be set | The fixed value. |
| extract_field | string
up to 100 charsonly one of extract_field, or fixed can be set | The name of the field whose value should be extracted. |
Example
```json
{
"extract_field": "field_name",
"id": "_i1yUnHjKfmWpCaD5Tazo"
}
```
# Rule.RuleFunnelConfiguration
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1536-L1544`]()
A funnel action combines data from multiple steps in a single flow into one chart that shows
drop-off between steps. Each funnel step corresponds to a match rule in the flow, identified by
its match ID.
| Field | Type | Description |
|---|---|---|
| ids | array of string
up to 100 items; server generated | The server-generated metric IDs for this funnel. There is one ID per referenced match ID, in the same order as `match_ids`. |
| match_ids | array of string
up to 100 items | The match IDs in the workflow that correspond to the steps of the funnel. All match IDs must be from the same flow. |
Example
```json
{
"ids": [
"fkQ1PfAZhdYvJexzY6DYuoYCZTEaWO0Y7spxwjr7akc"
],
"match_ids": [
"_i1yUnHjKfmWpCaD5Tazo"
]
}
```
# Rule.RuleMeasureTime
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1546-L1582`]()
| Field | Type | Description |
|---|---|---|
| name | string
up to 255 chars | A unique identifier for this action that will be included in the generated message body. |
| start_match_id | string
up to 100 chars | The match ID where the measurement starts. It must be in the same flow as `end_match_id`. |
| end_match_id | string
up to 100 chars | The match ID where the measurement ends. It must be in the same flow as `start_match_id`. |
| correlation_field_name | optional string
up to 100 chars | Correlates the start and end matches using a shared field value. This is useful when the start and end can be racy and we might otherwise measure time between unrelated events. For example: - Download started, id=A - Download started, id=B - Download completed, id=A - Download completed, id=B Without this we'd be measuring the time between B started and A completed. |
| additional_extracted_fields | array of string
up to 100 items | Additional fields to extract from the end match when the time measurement completes. |
| measure_time_condition | [bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime.MeasureTimeCondition](#bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime.MeasureTimeCondition "bitdrift.public.unary.workflows.v1.Rule.RuleMeasureTime.MeasureTimeCondition") | An optional condition to check when time measurement is complete. If specified, actions that target the match_id of this rule will only be triggered if the condition is met. |
Example
```json
{
"additional_extracted_fields": [
"field_name"
],
"correlation_field_name": "field_name",
"end_match_id": "_i1yUnHjKfmWpCaD5Tazo",
"measure_time_condition": {
"duration_threshold": "3600s",
"operator": "NOT_EQUAL"
},
"name": "name",
"start_match_id": "_i1yUnHjKfmWpCaD5Tazo"
}
```
# Rule.RuleMeasureTime.MeasureTimeCondition
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1547-L1553`]()
| Field | Type | Description |
|---|---|---|
| operator | [bitdrift.public.unary.workflows.v1.Operator](bitdrift_public_unary_workflows_v1_Operator.md "bitdrift.public.unary.workflows.v1.Operator")
must be a defined enum value | The operator to use when evaluating the duration threshold. |
| duration_threshold | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration "google.protobuf.Duration") | The duration threshold to use when evaluating the condition. |
Example
```json
{
"duration_threshold": "3600s",
"operator": "NOT_EQUAL"
}
```
# Rule.RuleTimeout
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1587-L1600`]()
A timeout-based exit that can be attached anywhere a step can define exit conditions. Timeout
exits are terminal and do not advance to another step. A single step can define at most one
timeout exit.
| Field | Type | Description |
|---|---|---|
| duration | uint32
greater than 0 | The length of time to wait before the timeout exit fires. |
| duration_unit | [bitdrift.public.unary.workflows.v1.Rule.RuleTimeout.DurationUnit](#bitdrift.public.unary.workflows.v1.Rule.RuleTimeout.DurationUnit "bitdrift.public.unary.workflows.v1.Rule.RuleTimeout.DurationUnit")
must be a defined enum value | The unit for `duration`. |
Example
```json
{
"duration": 1,
"duration_unit": "SECONDS"
}
```
# Rule.RuleTimeout.DurationUnit Enum
**Source definition:** [`src/bitdrift/public/unary/workflows/v1/workflow.proto#L1588-L1593`]()
| Name | Description |
|---|---|
| MILLISECONDS | |
| SECONDS | |
| MINUTES | |
| HOURS | |