Skip to content
View as Markdown

ListWorkflowsResponse

Field Type Description
items repeated bitdrift.public.unary.explorations.v1.ListWorkflowsResponse.Item An array of workflow objects. See Workflow for details about the object.
total_workflows uint32 The total number of workflows (regardless of pagination).
total_active_workflows uint32 The total number of active workflows (regardless of pagination).
total_filtered_workflows uint32 The total number of filtered workflows (regardless of pagination).

Example

JSON
{
  "items": [
    {
      "workflow": {
        "actions": [
          {
            "metric_chart_rule": {
              "time_series": [
                {
                  "aggregated_id": "abc-123-def",
                  "rate": {
                    "denominator": {
                      "match_id": "match-abc",
                      "name": "My Workflow"
                    },
                    "denominator_id": "abc-123-def",
                    "group_by": {
                      "values": [
                        {
                          "log_body": false
                        }
                      ]
                    },
                    "numerator": {
                      "match_id": "match-abc",
                      "name": "My Workflow"
                    },
                    "numerator_id": "abc-123-def"
                  },
                  "track_unique": {
                    "device_id": true
                  }
                }
              ]
            },
            "rule_id": "actn_ghi789"
          }
        ],
        "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": "match-abc",
                      "sample_rate": 100
                    }
                  }
                ],
                "loop_match_id": "match-abc",
                "match_rule": {
                  "generic_match": {
                    "base_matcher": {
                      "log_field": "field_name",
                      "operator": "EQUAL",
                      "string_value": "example"
                    }
                  },
                  "match_id": "match-abc",
                  "sample_rate": 100
                },
                "save_fields": [
                  {}
                ]
              }
            ]
          }
        ],
        "group_by_fields": [
          "field_name"
        ],
        "id": "wrkf_abc123",
        "name": "My Workflow",
        "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"
      }
    }
  ],
  "total_active_workflows": 42,
  "total_filtered_workflows": 42,
  "total_workflows": 42
}

ListWorkflowsResponse.Item

Field Type Description
workflow bitdrift.public.unary.explorations.v1.Workflow The workflow returned for this list item.

Example

JSON
{
  "workflow": {
    "actions": [
      {
        "metric_chart_rule": {
          "time_series": [
            {
              "aggregated_id": "abc-123-def",
              "rate": {
                "denominator": {
                  "match_id": "match-abc",
                  "name": "My Workflow"
                },
                "denominator_id": "abc-123-def",
                "group_by": {
                  "values": [
                    {
                      "log_body": false
                    }
                  ]
                },
                "numerator": {
                  "match_id": "match-abc",
                  "name": "My Workflow"
                },
                "numerator_id": "abc-123-def"
              },
              "track_unique": {
                "device_id": true
              }
            }
          ]
        },
        "rule_id": "actn_ghi789"
      }
    ],
    "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": "match-abc",
                  "sample_rate": 100
                }
              }
            ],
            "loop_match_id": "match-abc",
            "match_rule": {
              "generic_match": {
                "base_matcher": {
                  "log_field": "field_name",
                  "operator": "EQUAL",
                  "string_value": "example"
                }
              },
              "match_id": "match-abc",
              "sample_rate": 100
            },
            "save_fields": [
              {}
            ]
          }
        ]
      }
    ],
    "group_by_fields": [
      "field_name"
    ],
    "id": "wrkf_abc123",
    "name": "My Workflow",
    "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"
  }
}