• Documentation
  InstallationUsing the Kentico interfaceDeveloping websitesConfiguring KenticoManaging usersSecuring websitesDeploying websitesManaging website contentMultilingual websitesMacro expressionsExternal utilitiesIntegrating 3rd party systemsCustom developmentE-commerce featuresOn-line marketing featuresCommunity featuresRunning Kentico on Microsoft AzureUsing Amazon web services with KenticoCertified extensionsReferencesRelease notes - Kentico 11
• Tutorial
  Getting started with KenticoUsing the Kentico interfaceSite development overviewPortal Engine developmentMVC development
• API Examples
  Content managementOn-line marketingE-commerceSocial and CommunityDevelopmentConfiguration

When a user clicks the button, the API creates an analytics log. Once the system processes the log, the results containing the given user's name and the amount of clicks are stored in the database, where they can be used by the web analytics application.

Integrating custom analytics into the website

Now you need to publish the user control on your website (this example uses the sample Corporate site).

1. Log into the Kentico administration interface.
2. Edit the Corporate site in the Pages application.
3. Select the Home page in the content tree and switch to the Design tab.
4. Add the User control web part to the Main zone zone.
5. Type ~/CorporateSite/AnalyticsButton.ascx into the web part's User control virtual path property.
   • The page now displays the custom button.
6. View the live site version of the Home page and click the Add analytics hit button several times to add hits to the custom statistic.
   • Try doing this while logged in under different user accounts.

There are also other ways to add custom web analytics functionality to the pages of your website. For example:

• You can implement the control as a custom web part, add it to your pages and configure it through the portal engine as necessary.
• If you are using the ASPX page template development model for your website, you can integrate the analytics logging code and any required interface elements directly into your page templates.

Creating reports for statistics

Before users can view the statistics of the button click event in the Web analytics application, you need to create reports for displaying the data of the custom statistic. Most statistics have five types of reports: hourly, daily, weekly, monthly and yearly.

1. Open the Reporting application and select the Web Analytics category in the tree.

   • The sub‑categories contain reports used by the default statistics such as page views, traffic sources, etc.

2. Click ... next to the New report button above the tree and select New category in the menu.

3. Type Button clicks as the Category display name and click Save.

4. Create a daily report for the new statistic. Click New report and enter the following values:

   • Report display name: Button clicked - daily report

   • Report name: buttonclicked.dayreport

     The names of the reports must use a specific format:

     • <statistic code name>.hourreport
     • <statistic code name>.dayreport
     • <statistic code name>.weekreport
     • <statistic code name>.monthreport
     • <statistic code name>.yearreportIn this example, the code name of the custom statistic is buttonclicked, as defined above in the code of the user control.

5. Click Save.

6. Switch to the Parameters tab of the new report and use the New field button to create three essential parameters, which the web analytics use internally:

   • Field name: FromDate

   • Data type: Date and Time

   • Display field in the editing form: disabled

     Click Save for every parameter before moving on to the next one.

   • Field name: ToDate

   • Data type: Date and Time

   • Display field in the editing form: disabled

     The two parameters above define a time interval used to limit which data of the statistic should be loaded. Only hits that occurred during the specified interval will be displayed in the report. The values of these parameters can be set by users when viewing the data of the statistic in the web analytics interface.

     • Field name: CodeName
     • Data type: Text
     • Size: 20
     • Default value: buttonclicked (the code name of the displayed statistic in general)
     • Display field in the editing form: disabled
     The system uses the CodeName parameter to identify from which statistic the report loads data. The value is usually not modified if the report is dedicated to a single statistic (like the one in this example).

     

7. Go to the General tab and click New in the Tables section below the layout editor. Fill in the table's properties as shown below:

   • Display name: Table

   • Code name: Table_ButtonClicked_Day

   • Enable export: true (checked)

   • Query:

     SQL

     Copy

     SET @FromDate = dbo.Func_Analytics_DateTrim(@FromDate,'day');
     SET @ToDate = dbo.Func_Analytics_EndDateTrim(@ToDate,'day');
     
     SELECT StatisticsObjectName as 'User', SUM(HitsCount) as 'Hits'
     FROM Analytics_Statistics, Analytics_DayHits
     WHERE (StatisticsSiteID = @CMSContextCurrentSiteID)
     AND (StatisticsCode = @CodeName)
     AND (StatisticsID = HitsStatisticsID)
     AND (HitsStartTime >= @FromDate)
     AND (HitsEndTime <= @ToDate)
     GROUP BY StatisticsObjectName
     ORDER BY SUM(HitsCount) DESC

8. Click Save & Close to create the table.

9. Click Insert in the Tables section to add the new table into the report.

10. Click Save.

The daily report is now complete. In a real‑world scenario, the report would usually also contain a graph to display the data. See the Working with system reports chapter to learn more about graphs and other reporting options.

You can create the reports for the remaining time intervals using the same approach. The only differences should be in the names of the reports and tables, and the code of the queries, where you need to load data from the appropriate tables – Analytics_YearHits in the yearly report, Analytics_MonthHits in the monthly report, etc. You can make this process easier by using the Clone report () button in the menu above the report tree. Simply create copies of the daily report and then make the necessary adjustments.

Setting the title for custom statistics

To ensure that the user interface displays an appropriate title for your custom statistic, you need to create a resource string:

1. Open the Localization application.
2. Click New string on the Resource strings tab.
3. Enter the Key of the string in format: analytics_codename.<statistic code name> (analytics_codename.buttonclicked for this example)
4. Type the text of the string for your system's default culture, for example: Button clicks
   • If you are using a multilingual UI, you can enter translations of the string for individual cultures.
5. Click Save.

The system uses the string as the title for the matching statistic.

Result

Once there are some hits logged in the database for a custom statistic, the system automatically displays the statistic under the Custom category of the tree in the Web analytics application. The reports of the sample statistic show the number of hits logged for the tracked button click event.