Example (Static Flow)

See how events are generated when a project with the static flow is run on an app.
A sample static flow enabled project
These are the events that are generated when the above project with the static flow is run.
  • START
    1. 1.
      flow_start
      To group analytics events for this project, use projectName
      {
      "id": "8b8bbc83-79bf-4948-beff-75be9df8bcf1",
      "timestamp": "2021-07-02T01:18:56Z",
      "eventName": "flow_start",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "deploymentName": "Onboarding flow"
      }
    2. 2.
      flow_opt_in or flow_opt_out
      flow_opt_in occurs when the user clicks on Take a tour (if opt-in is configured for this button). If the cross or overlay is clicked then you will get flow_opt_out as eventName
      {
      "id": "bf77b357-bb53-4d77-b4f2-3e15820d173d",
      "timestamp": "2021-07-02T01:19:13Z",
      "eventName": "flow_opt_in", //or flow_opt_out
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "deploymentName": "Onboarding flow"
      }
  • STEP 1 (Highlight, if flow_opt_in)
    1. 1.
      element_seen You can track this element using elementName in combination with projectName
      {
      "id": "f274dbdb-1e7f-4c91-86a7-017df7a0a4a3",
      "timestamp": "2021-07-02T01:19:14Z",
      "eventName": "element_seen",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 1",
      "deploymentName": "Onboarding flow"
      }
    2. 2.
      element_action Whenever the user clicks on the Next button, you can track the interaction of this element by using actionEventValuei.e. Next (name of the button). You can use the combination of projectName and elementName to identify this element uniquely.
      {
      "id": "57c3de8f-cc3c-42bb-9b5c-1170d85e4916",
      "timestamp": "2021-07-02T01:19:20Z",
      "eventName": "element_action",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 1",
      "actionEventType": "close",
      "actionEventValue": "Next",
      "deploymentName": "Onboarding flow"
      }
  • STEP 2 (Tooltip)
    1. 1.
      element_seen You can track this element using elementName in combination with projectName
      {
      "id": "aa496d41-ed05-491a-9a45-d22ca306f89c",
      "timestamp": "2021-07-02T01:35:55Z",
      "eventName": "element_seen",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 2",
      "deploymentName": "Onboarding flow"
      }
    2. 2.
      element_action
      Whenever the user clicks on Anchor(Search Icon), you can track the interaction of this element using actionEventValue i.e. anchor_click. You can use the combination of projectName and elementName to identify this element uniquely.
      {
      "id": "b1296055-8c18-4717-bf01-cba8337226f5",
      "timestamp": "2021-07-02T01:36:14Z",
      "eventName": "element_action",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 2",
      "actionEventType": "anchor_click",
      "deploymentName": "Onboarding flow"
      }
  • STEP 3 (Tooltip)
    1. 1.
      element_seen You can track this element using elementName in combination with projectName
      {
      "id": "66ac23f4-9a85-4134-983f-618a6b24eaa7",
      "timestamp": "2021-07-02T01:36:41Z",
      "eventName": "element_seen",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 3",
      "deploymentName": "Onboarding flow"
      }
    2. 2.
      element_action
      Whenever the user clicks on Anchor(Cart Icon), you can track the interaction of this element using actionEventValue i.e. anchor_click. You can use the combination of projectName and elementName to identify this element uniquely.
      {
      "id": "2288274c-3767-4331-ad7b-e96ee057974d",
      "timestamp": "2021-07-02T01:37:12Z",
      "eventName": "element_action",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 3",
      "actionEventType": "anchor_click",
      "deploymentName": "Onboarding flow"
      }
  • STEP 4 (FullScreen)
    1. 1.
      element_seen
      You can track this element using elementName in combination with projectName
      {
      "id": "723e944a-defa-45e4-8f17-b08f20369b82",
      "timestamp": "2021-07-02T01:37:17Z",
      "eventName": "element_seen",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 4",
      "deploymentName": "Onboarding flow"
      }
    2. 2.
      element_action Whenever the user clicks on the Next button, you can track the interaction of this element by using actionEventValue i.e. Awesome! (name of the button). You can use the combination of projectName and elementName to identify this element uniquely.
      {
      "id": "5aca67c6-6b51-4eb6-b298-788595bbe60b",
      "timestamp": "2021-07-02T01:38:34Z",
      "eventName": "element_action",
      "projectName": "Onboarding flow",
      "deploymentVersion": "3",
      "language": "ang",
      "pageName": "page 1",
      "elementName": "Step 4",
      "actionEventType": "close",
      "actionEventValue": "Awesome!",
      "deploymentName": "Onboarding flow"
      }
  • STEP 4 (flow_success)
    We will get flow_success immediately after the element_action event.
    {
    "id": "6691f2be-773c-4dfa-ba74-0bb73898bd51",
    "timestamp": "2021-07-02T01:38:34Z",
    "eventName": "flow_success",
    "projectName": "Onboarding flow",
    "deploymentVersion": "3",
    "language": "ang",
    "deploymentName": "Onboarding flow"
    }
For FLOW_MENU
{
"id": "a711961b-7531-4b5e-b2dc-ae01395fe244",
"timestamp": "2021-09-06T06:59:26Z",
"eventName": "flow_success",
"projectName": "Partner Traning", //Flow Menu project name
"selectedFlow": "Create a follow-up task" //Selected flow title
"deploymentVersion": "7",
"language": "ang",
"deploymentName": "Partner Traning",
}
We getflow_success in Step 4 as inSTATIC FLOW, the last step is considered a success.
Apart from the above, we can also get these events:
  1. 1.
    flow_disable - If a user drags and dismisses the flow.
  2. 2.
    flow_stop - If a user stops the flow by selecting the option on the icon press
  3. 3.
    flow_language_change - If you have configured a multilingual project, then there are chances that the user might change the language.