Reporting and Engagement¶

Reports is a component in Kitsune which enables reporting and proactive engagement emails to be sent to your customers. You can configure what and when emails should be sent through this component. You also have complete control over the email template. Edit it the same way you edit HTML pages in Kitsune and you are good to go. Data-points of the reports are provided to you by a system defined language which you can refer to in the language editor section of the IDE.

Enabling Reports¶

Step 1:¶

Open your Kitsune project. Under 'components' menu, click on 'reports'. Click 'enable' in the confirmation dialog. This will add the required files to your project automatically and will also enable the reporting service. A new folder '__components' will be added with a subfolder 'reports' under which your files will be located.

Step 2:¶

Design an email template which you want to send as a report. Follow the system defined language to know what is being exposed and how you can access it. Update that email template file name in kitsune-settings.json under reports section.

Note: A predefined ready-to-use performance report will be added to your project under the '__components/reports/templates' folder. It makes use of the language properties to the full extent to send a good looking report to your customers.

Step 3:¶

Once you are done with your customizations (logo etc.), you can build the project and check the preview by right click > preview page on that file in the left panel.

Report settings reference¶

Root object¶

NotificationItem object¶

NotificationItem.Email object¶

Settings object¶

Settings.Email object¶

Sample reports section in kitsune-settings.json for enabling periodic performance reports to be sent to your customers every 7 days.

 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

{
  ...
  "reports": {
        "notifications": [
            {
                "type": "PERIODIC_PERFORMANCE_REPORT",
                "period": 7,
                "email": {
                    "body": "periodic_performance_report.html"
                }
            }
        ],
        "settings": {
            //Fill the details below to use your own email service provider or remove this section to use Kitsune's default email service provider
            "email": {
                "host": "",
                "port": 0,
                "username": "",
                "password": "",
                "ssl_enabled": true
            }
        }
    }
  ...
}

Report language reference¶

Reports component gets its data from reports language. Data like visits, visitors etc is provided to you by reports language so that you can use them out of the box and focus only on the design of the email.

All the properties of reports language can be accessed using report.<property_name>

The following are available properties provided by reports language :

Report object¶

PeriodicPerformanceStatistics object¶

PerformanceStatistics object¶

TopReferrersItem object¶

MostVisitedPagesItem object¶

DateRange object¶