#DRAFT

Getting started # TODO

This guide illustrate how you can configure your domain and set up different options so you can install unk sdk.

Create your domain

If you don't have any domain, the app will request you to create a new domain.


Following the link, you can create your new domain. Note that the domain field is not your website hostname or address. It is just an alias so you can identify the correct domain to work with.


Domain selection

Note that you should select a domain to work with. If you have multiple domains, you can create or change the current selection.

After the domain creation, you should be able to select a domain (1) from the options list or create another new domain (2).
See menu



If you select the domain to work with, the alias(name) of the domain will appears in top navigation bar.

Domain configuration

The next step is to configure origins and api keys. If the configuration is missed, the application will request to setup the missing parameters.

Configure origins
This field let you define what are the list of allowed origins of your website from where unk can collect analytics. If your install unk sdk.js for your website https://abc.com, you should add abc.com to the allowed origins field. You can define more than one origin. You just need to separate the list by a comma ,.

Create api key
An api key is an identifier for your domain. Mixed with defined origins, only allowed origins can collect analytics from your website.


Setting Menu
The picture below shows the links to access different configurations for the current selected domain and the list of other domains.
  • * Change the current working domain you can select from all your domain in the select options (1).
  • * Add new domain (2)
  • * Configure selected domain origins (3)
  • * Configure selected domain api key (4)


Sdk integration


This section describe how to install the js sdk on your website and initialize the analytics with your api key.
SDK js installation

First step is to install the js sdk by including this line in your html file. It's preferred to be in head bloc but it works fine in body also.
<script src="https://www.unknownanalytics.com/sdk.js"></script>

SDK js initialisation

The next step is to initialize the sdk using your api key and the instruction below.
unkAnalytics(<your_api_key>);


You can turn off unk for reporting using the unkAnalytics.off();
You can also turn the sdk on by calling unkAnalytics.on();

Known issues and uses cases

You may have some csp restrictions or configuration in your website (more). in this case you may encounter another issue related to script-src and nonce. If this is case, you can download and install the latest version of the sdk and serve it from your server.
If you still have an issue preventing the app from being installed please Contact Us --> .

Overview


This page display a summary of metrics related to domains.
Summary view


Page views


This section describe how to install the js sdk on your website and initialize the analytics with your api key.

Global view

Specific page view

Using the autocomplete input, you can filter to select a page for your pages list. here we selected the /dashboard/stats/errors

Geo


This feature is enabled in domain settings. By default it is disabled. See menu


Bubble view

Choropleth view

Errors


Export Partial

Events soon

Heatmaps soon