Skip to content

Workflow additional info (sidedata) API

Warning

This section is still under construction and is subject to changes like naming etc.

This endpoint provides a way to fetch some additional information related to a Workflow. Information like count of goals triggered, started workflow count, unique visitor count, hourly number of visitors etc. can be fetched & displayed in addition to the workflow report diagram.

Endpoint

1
POST https://api.giosg.com/api/reporting/workflow/v1/orgs/<organization_id>/workflows/<workflow_id>/sidedata/

URL attributes

Attribute Type Required Description
organization_id String (UUID) Required ID of the organization for which the data is requested
workflow_id String (UUID) Required ID of the workflow for which the data is requested

Payload

1
2
3
4
5
6
{
    "interval": {
        "start": "<datetime_ISO8601>",
        "end": "<datetime_ISO8601>"
    }
}

Payload attributes

Attribute Type Required Description
interval Interval Required Time interval of the query, with start and end being in ISO8601 time format

Response (page navigation)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
    "timeframe_stat": {
        "day_in_week": [
            [
                6074,
                1
            ],
            [
                7115,
                2
            ],
            [
                6465,
                3
            ],
            [
                6615,
                4
            ],
            [
                6003,
                5
            ],
            [
                2278,
                6
            ],
            [
                2208,
                7
            ]
        ],
        "hour_in_day": [
            [
                554,
                0
            ],
            [
                575,
                1
            ],
            [
                594,
                2
            ],
            [
                699,
                3
            ],
            [
                1689,
                4
            ],
            [
                3219,
                5
            ],
            [
                3792,
                6
            ],
            [
                3424,
                7
            ],
            [
                2791,
                8
            ],
            [
                2483,
                9
            ],
            [
                2412,
                10
            ],
            [
                2337,
                11
            ],
            [
                2082,
                12
            ],
            [
                1767,
                13
            ],
            [
                1278,
                14
            ],
            [
                1098,
                15
            ],
            [
                979,
                16
            ],
            [
                887,
                17
            ],
            [
                834,
                18
            ],
            [
                764,
                19
            ],
            [
                687,
                20
            ],
            [
                648,
                21
            ],
            [
                576,
                22
            ],
            [
                589,
                23
            ]
        ]
    },
    "unique_visitors_count": 9082,
    "unique_sessions_count": 20812
}

Response attributes

Attribute Type Description
timeframe_stat Object Depending on the interval given, can contain 1 to 2 different attributes, hour_in_day or day_in_week. Both attributes are arrays that contain arrays with format [metric_value, index] with index being the day / hour. With hours the index starts from 0 (range 0 - 23) but with weeks the index starts from 1 (range 1 - 7)
unique_visitors_count Number Amount of unique visitors
unique_sessions_count Number Amount of unique sessions

Response (interaction)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
    "unique_visitors_count": 5,
    "started_workflows_count": 9,
    "sum_of_visitor_purchases": [
        {
            "value": 50.0,
            "currency": "EUR"
        }
    ],
    "triggered_goals": [
        {
            "uid": "ab5acdaa-91b5-11ed-8cc3-0242ac120003",
            "name": "ab5acdaa-91b5-11ed-8cc3-0242ac120003",
            "metrics": 1
        },
        {
            "uid": "ab5acdaa-91b5-11ed-8cc3-0242ac120003",
            "name": "test goal",
            "metrics": 1
        }
    ],
    "affected_goals": [
        {
            "uid": "711b8d24-6243-11e8-8691-0242ac110008",
            "metrics": 1,
            "name": "Marketing: Visitor chatted (all chats)"
        },
        {
            "uid": "7e356aee-d6c3-11e8-a640-0242ac11000c",
            "metrics": 1,
            "name": "Marketing: Visitor chatted (real chats)"
        },
        {
            "uid": "a413c31a-b804-11ed-b21a-0242ac12000d",
            "metrics": 1,
            "name": "Reporting test 2"
        },
        {
            "uid": "a8a565bc-df92-11e9-8b6c-0242ac110014",
            "metrics": 1,
            "name": "Marketing: 2 or more visits chatted"
        },
        {
            "uid": "b984fcf0-b804-11ed-a220-0242ac120005",
            "metrics": 1,
            "name": "Reporting test 3"
        },
        {
            "uid": "d405aa0a-b7fc-11ed-a13b-0242ac120009",
            "metrics": 1,
            "name": "Reporting test1"
        },
        {
            "uid": "3b317fad-b163-463a-9720-774143be96e9",
            "metrics": 1,
            "name": "System: Visitor purchased"
        }
    ]
}

Response attributes

Warning

Some variables may be subject to name changes & add information like

  • triggered_goals: triggered by IB, when for example an interaction view is shown to the visitor
  • affected_goals: for example when a cart was locked within 24 hours by a visitor, who interacted
Attribute Type Description
unique_visitors_count Number Amount of unique visitors
started_workflows_count Number Amount of started workflows
visitor_purchase_sums List of objects If one or more affected goals are named "System: Visitor purchased" this list will contain total sums grouped by currency. Objects in list will have value & currency attributes
triggered_goals List of objects Amount of goals that were triggered. Object contains following attributes: uuid, name & metrics
affected_goals List of objects Amount of outer goals that are related to the workflow. Object contains following attributes: uuid, metrics, & name