---
search:
exclude: true
---
# GetWorkflowResponse
| Field | Type | Description |
|---|---|---|
| workflow | [bitdrift.public.unary.workflows.v1.Workflow](bitdrift_public_unary_workflows_v1_Workflow.md#bitdrift.public.unary.workflows.v1.Workflow){ title="bitdrift.public.unary.workflows.v1.Workflow"} | The workflow that was retrieved in full. |
| metadata | [bitdrift.public.unary.workflows.v1.WorkflowMetadata](bitdrift_public_unary_workflows_v1_WorkflowMetadata.md#bitdrift.public.unary.workflows.v1.WorkflowMetadata){ title="bitdrift.public.unary.workflows.v1.WorkflowMetadata"} | The metadata for the workflow. |
| per_rule_chart_metadata | repeated [bitdrift.public.unary.workflows.v1.PerRuleChartMetadata](bitdrift_public_unary_workflows_v1_PerRuleChartMetadata.md#bitdrift.public.unary.workflows.v1.PerRuleChartMetadata){ title="bitdrift.public.unary.workflows.v1.PerRuleChartMetadata"} | The chart metadata that applies to this workflow. |
#### Example
```json
{
"metadata": {
"deployment_expiration": {
"fixed_time": {
"time": "3600s"
}
},
"description": "Workflow description",
"per_rule_metadata": [
{
"rule_id": "_i1yUnHjKfmWpCaD5Tazo",
"title": "Rule title"
}
]
},
"per_rule_chart_metadata": [
{
"metadata": {
"metric_chart_metadata": {
"metadata": [
{
"connector_export_config": [
{
"cloudwatch_connector_export_config": {
"fixed_dimensions": {
"key": ""
},
"metric_name": "foreground_launches",
"namespace": "mobile_metrics"
},
"connector_name": "cloudwatch-primary"
}
],
"limit_strategy": {},
"sort_order": "DESC",
"title": "Time series title",
"top_k_algorithm": "MAX",
"y_axis": {
"description": "Count",
"unit": "COUNT"
}
}
],
"time_series_display_mode": {}
},
"no_data_message": "Example text",
"summary": {
"description": "Example text"
},
"title": "Chart title"
},
"rule_id": "_i1yUnHjKfmWpCaD5Tazo"
}
],
"workflow": {
"actions": [
{
"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"
}
],
"created_at": "2024-01-15T09:30:00Z",
"deployed_at": "2024-01-15T09:30:00Z",
"deployment_expiration_time": "2024-01-15T09:30:00Z",
"flows": [
{
"exclusive": {},
"steps": [
{
"exit_conditions": [
{
"match_rule": {
"generic_match": {
"base_matcher": {
"log_field": "field_name",
"operator": "EQUAL",
"string_value": "example"
}
},
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"sample_rate": 100
}
}
],
"loop_match_id": "_i1yUnHjKfmWpCaD5Tazo",
"match_rule": {
"generic_match": {
"base_matcher": {
"log_field": "field_name",
"operator": "EQUAL",
"string_value": "example"
}
},
"match_id": "_i1yUnHjKfmWpCaD5Tazo",
"sample_rate": 100
},
"save_fields": [
{
"field_name": "",
"id": "",
"regex_capture": ""
}
]
}
]
}
],
"group_by_fields": [
"field_name"
],
"id": "DFg5",
"name": "Workflow name",
"owner": {
"email": "user@example.com",
"id": "usr_abc123",
"name": "Jane Doe"
},
"platform_targets": [
{
"apple": {
"apps": [
{
"app_id": "com.example.app"
}
]
}
}
],
"state": "LIVE",
"updated_at": "2024-01-15T09:30:00Z"
}
}
```