Conversational Reporting Concepts
Overview¶
At giosg we would like to make your life as easy as possible, that is why giosg would like to present Conversational Reporting. With Conversational Reporting you get reporting in a quick and handy package, you will receive notifications when the metrics are available and your users can immediately discuss these within giosg, Slack and/or through E-Mail, you decide!
Understanding the Conversational Reporting concepts¶
A Workflow is a list of Actions that achieve a specific business outcome. An example of this outcome could be: "Close Deals" and the name of the workflow could be "Website Lead to Deal". A task is the basic building block of all workflows. Task can be performed by individuals or machines. They can vary dramatically in complexity and time required for completion. For example: "Show leadform to Visitor" is performed by code run on the web-browser vs. "Contact Visitor" about deal is done by sales person.
An Business Objective is an underlying metric that points to the performance of a workflow and you can create as many of these as you want.
For each Business Objective you can set Target Level(s). For the above example "Website Lead to Deal" we could use a Target Level for example: "Get at least 50 leads per day". A Target Level can have multiple notification settings.
Conversational Reporting allows you to send notifications about workflow performance. These are presented as cards, which contain information about Business Objectives in the workflow:
Workflow¶
In Conversational Reporting a workflow has the following properties:
Field | Description |
---|---|
name | What is the name of the workflow |
description | The description or the purpose of the workflow |
Notification Settings¶
To report the Objective and related Target Level, we will need to dictate where we send these messages to. With notification settings, the user can configure that. Conversational reporting currently offers three methods for reporting: giosg Groups, Slack and E-Mail. You can attach one notification setting to multiple targets with their respective UUID
.
A notification setting has following properties:
Field | Description |
---|---|
id | Unique UUID for this setting |
name | Name of the setting |
giosg Groups¶
A Group notification setting has also following properties:
Field | Description |
---|---|
channel_id | Group identifier |
Email¶
An Email notification setting has also following properties:
Field | Description |
---|---|
Email address | |
is_bundleable | Can the message be bundled or not |
Slack¶
A Slack notification setting has also following properties:
Either
Field | Description |
---|---|
token | Token for slack |
channel | Channel where message is being sent |
user | User who will send the message |
OR
Field | Description |
---|---|
incoming_webhook_url | Webhook url for slack |
Target Level¶
A Business Objective is an underlying metric that points to the performance of a workflow, you can create as many as you want. For the above example "Website Lead to Deal" we could use a Target Level for example: "Get at least 50 leads per day". A Target Level can have multiple notification settings.
A Target Level has following properties:
Field | Description |
---|---|
name | Name of the Target Level |
reporting_query | Objective query to Giosg reporting system |
reporting_threshold | Target Level threshold. For example '50'. |
reporting_bound | Should the Target Level bound be bigger or smaller than query threshold. Options: "UPPER" i.e. result < threshold and "LOWER" i.e. result >= threshold |
reporting_field | What is the field from the result that should be compared to the threshold |
reporting_period | ISO 8601 duration. Options: "P1D", "P1W" or "P1M" i.e. daily, weekly and monthly, respectively |
notification_period | ISO 8601 duration. Options: "P1D", "P1W" or "P1M" i.e. daily, weekly and monthly, respectively |
notification_settings | A list of notification settings attached to this conversational reporting target. |