Skip to content

Workflow step source data API

Warning

This section may be updated soon!

This endpoint provides a collection of detailed data on each individual event in each step of the workflow, which is aggragated to make up the data of each step of the workflow

To check how to download source data, check this page

Endpoint

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

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
step_index Positive integer Required Index of the step for which the data is requested

Payload

 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
{
    "filters":[
        {
            "property": "action", 
            "values": [ "action name" ]
        }
    ],
    "step_data": [
        {},
        {
            "actions": [
                "element-cp9yu8spgp4z9boskasdjowidstam83w1h4h",
                "element-tokxiwmi2gtobcjnlskdsk2kdasdazasrk5m"
            ]
        },
        {
            "actions": [
                "element-tasd2k3d2gtobcjnje1towkasdok23dkowqa"
            ]
        }
    ],
    "interval": {
        "start": "<start_time_ISO8601>",
        "end": "<end_time_ISO8601>",
    },
    "limit": 1000,
    "target": "default" | "triggered_goal",
    "basic": false | true
}

Payload attributes

Attribute Type Required Description
filters Array of filters Required An array of filter objects used to filter the response. For example you can use action property in filters to get the data for the particular action. Follow this link for more information about filtering
step_data Array of objects Optional An array of objects that describe the step. If this attribute is omitted for the payload of web navigation and interaction workflows, the API will return all events for the current step regardless of the data shown on the chart. For voice & video, chat and user-generated workflows this attribute is ignored and events returned by the API always correspond to data on the chart
interval Interval Required Time interval of the query, with start and end being in ISO8601 time format
limit Positive integer Optional A number of rows to return in the response. Must be greater than 0. If this attribute is ommitted, the API will return all relevant data
target String Optional String describing if information that is fetched is related to goal or the step action. Accepts default or triggered_goal. Default value is default if omitted from payload.
basic Boolean Optional Boolean value that describes if response gives basic or advanced data. Basic is more human readable and advanced is "raw" data from database. Default value is false if omitted from payload.

Payload step_data objects explanation

Each object in the step_data array represents a corresponding step. For example: step_data[0] - corresponds to source step, step_data[1] - corresponds to step 1 and so on. An empty object can be passed for the source step(step_data[0]), as source step data is not used in processing

step_data objects can contain the following attribute:

Attribute Type Required Description
actions Array of strings Optional An array of action identifiers. For different types of workflows this array can contain different types of identifiers. For a web navigation workflow, this array contains page_url values for actions, for interaction workflow this array contains view_uid values for actions

Response

Response from the API is an object which contains fields and data elements.

Attribute Type Description
fields Array An array of objects that describe the schema for the data elements
data Array An array of objects, each representing data for a single event 
 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
{
    "fields": [
        {
            "name": "timestamp",
            "type": "datetime",
            "tz": "UTC"
        },
        {
            "name": "source",
            "type": "string"
        },
        {
            "name": "event_version",
            "type": "integer"
        },
        ...
    ],
    "data": [
        {
            "timestamp": "2022-11-03T10:45:54.000Z",
            "source": "",
            "event_version": 1,
            ...
        },
        ...
}

Response HTTP status codes

Warning

This section should be fact-checked before going live!

Endpoint returns the following HTTP status codes:

  • 200 if the request was successful
  • 401 if you are not authenticated
  • 403 if you do not have active subscription
  • 403 if you do not have access to the organization
  • 403 if you do not have reporting permission
  • 404 if data was not found
  • 406 if filtering with something that is not yet implemented
  • 500 if an unexpected error occurred with the query

Example Requests / Responses

Example Request (basic)

1
POST https://api.giosg.com/api/reporting/workflow/v1/orgs/e40bcb66-8c63-4aa7-8d81-68d8e8cef907/workflows/d3f3323f-9787-4abd-850d-9b9b3a5cc6f9/step/1'

Request Payload

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "filters":[
        {
            "property": "action", 
            "values": [ "User dialed" ]
        }
    ],
    "interval": {
        "start": "2022-11-03T00:00:00+00:00",
        "end": "2022-11-04T00:00:00+00:00"
    },
    "limit": "2",
    "basic": true
}

Response

 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
{
    "fields": [
        {
            "name": "Date & Time",
            "type": "datetime",
            "tz": "UTC"
        },
        {
            "name": "View title",
            "type": "string"
        },
        {
            "name": "Browser",
            "type": "string"
        },
        {
            "name": "Device",
            "type": "string"
        },
        {
            "name": "City",
            "type": "string"
        },
        {
            "name": "Country",
            "type": "string"
        },
        {
            "name": "ISP or organisation",
            "type": "string"
        },
        {
            "name": "OS (operating system)",
            "type": "string"
        },
        {
            "name": "Interaction Workflow ID",
            "type": "string"
        },
        {
            "name": "Workflow Session ID",
            "type": "string"
        },
        {
            "name": "Visitor ID",
            "type": "string"
        }
    ],
    "data": [
        {
            "Date & Time": "2023-04-13T00:00:06.000Z",
            "Interaction Workflow ID": "d3f3323f-9787-4abd-850d-9b9b3a5cc6f9",
            "View title": "view 3",
            "Visitor ID": "f7f8957a-accc-4202-9ba3-c297c903f017",
            "Workflow Session ID": "53390618-53fe-4491-bc3f-9edf4b56a27e",
            "Browser": "Edge",
            "Device": "desktop",
            "City": "Helsinki",
            "Country": "Finland",
            "ISP or organisation": "Giosg.com Oy",
            "OS (operating system)": "Windows"
        },
        {
            "Date & Time": "2023-04-13T00:00:06.000Z",
            "Interaction Workflow ID": "d3f3323f-9787-4abd-850d-9b9b3a5cc6f9",
            "View title": "view 3",
            "Visitor ID": "f7f8957a-accc-4202-9ba3-c297c903f017",
            "Workflow Session ID": "53390618-53fe-4491-bc3f-9edf4b56a27e",
            "Browser": "Edge",
            "Device": "desktop",
            "City": "Helsinki",
            "Country": "Finland",
            "ISP or organisation": "Giosg.com Oy",
            "OS (operating system)": "Windows"
        }
    ]
}

Example Request (advanced)

1
POST https://api.giosg.com/api/reporting/workflow/v1/orgs/e40bcb66-8c63-4aa7-8d81-68d8e8cef907/workflows/d3f3323f-9787-4abd-850d-9b9b3a5cc6f9/step/1'

Request Payload

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "filters":[
        {
            "property": "action", 
            "values": [ "User dialed" ]
        }
    ],
    "interval": {
        "start": "2022-11-03T00:00:00+00:00",
        "end": "2022-11-04T00:00:00+00:00"
    },
    "limit": "2",
    "basic": false
}

Response

  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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
{
    "fields": [
        {
            "name": "Date & Time",
            "type": "datetime",
            "tz": "UTC"
        },
        {
            "name": "source",
            "type": "string"
        },
        {
            "name": "event_version",
            "type": "integer"
        },
        {
            "name": "organization_id",
            "type": "string"
        },
        {
            "name": "organization_name",
            "type": "string"
        },
        {
            "name": "category",
            "type": "string"
        },
        {
            "name": "action",
            "type": "string"
        },
        {
            "name": "label",
            "type": "string"
        },
        {
            "name": "vendor",
            "type": "string"
        },
        {
            "name": "properties",
            "type": "string"
        },
        {
            "name": "dim1",
            "type": "string"
        },
        {
            "name": "dim2",
            "type": "string"
        },
        {
            "name": "dim3",
            "type": "string"
        },
        {
            "name": "dim4",
            "type": "string"
        },
        {
            "name": "dim5",
            "type": "string"
        },
        {
            "name": "visitor_id",
            "type": "string"
        },
        {
            "name": "session_id",
            "type": "string"
        },
        {
            "name": "user_id",
            "type": "string"
        },
        {
            "name": "partner_organization_ids",
            "type": "string"
        },
        {
            "name": "browser_name",
            "type": "string"
        },
        {
            "name": "browser_version",
            "type": "string"
        },
        {
            "name": "device_screen_height",
            "type": "string"
        },
        {
            "name": "device_screen_width",
            "type": "string"
        },
        {
            "name": "device_type",
            "type": "string"
        },
        {
            "name": "geo_city",
            "type": "string"
        },
        {
            "name": "geo_country",
            "type": "string"
        },
        {
            "name": "ip_organization",
            "type": "string"
        },
        {
            "name": "os_name",
            "type": "string"
        },
        {
            "name": "os_version",
            "type": "string"
        },
        {
            "name": "value",
            "type": "number"
        }
    ],
    "data": [
        {
            "timestamp": "2022-11-03T10:45:54.000Z",
            "source": "",
            "event_version": 1,
            "organization_id": "e40bcb66-8c63-4aa7-8d81-68d8e8cef907",
            "organization_name": "",
            "category": "Call",
            "action": "User dialed",
            "label": "d3f3323f-9787-4abd-850d-9b9b3a5cc6f9",
            "vendor": "com.giosg.chat",
            "properties": [],
            "dim1": "34d69edb-22c2-4193-be0c-71623fa55fb9",
            "dim2": null,
            "dim3": null,
            "dim4": "Call start",
            "dim5": "1",
            "visitor_id": "89e42b58-d67c-4bd5-b035-71485ed57234",
            "session_id": null,
            "user_id": null,
            "partner_organization_ids": [],
            "browser_name": null,
            "browser_version": null,
            "device_screen_height": null,
            "device_screen_width": null,
            "device_type": null,
            "geo_city": null,
            "geo_country": null,
            "ip_organization": null,
            "os_name": null,
            "os_version": null,
            "value": 1.0
        },
        {
            "timestamp": "2022-11-03T10:45:54.000Z",
            "source": "",
            "event_version": 1,
            "organization_id": "e40bcb66-8c63-4aa7-8d81-68d8e8cef907",
            "organization_name": "",
            "category": "Call",
            "action": "User dialed",
            "label": "d3f3323f-9787-4abd-850d-9b9b3a5cc6f9",
            "vendor": "com.giosg.chat",
            "properties": [],
            "dim1": "34d69edb-22c2-4193-be0c-71623fa55fb9",
            "dim2": null,
            "dim3": null,
            "dim4": "Call start",
            "dim5": "1",
            "visitor_id": "89e42b58-d67c-4bd5-b035-71485ed57234",
            "session_id": null,
            "user_id": null,
            "partner_organization_ids": [],
            "browser_name": null,
            "browser_version": null,
            "device_screen_height": null,
            "device_screen_width": null,
            "device_type": null,
            "geo_city": null,
            "geo_country": null,
            "ip_organization": null,
            "os_name": null,
            "os_version": null,
            "value": 1.0
        }
    ]
}