---
title: Kilkaya
slug: experience/kilkaya
description: Kilkaya is a flexible analytics tool for news publishers. It includes live dashboards, reports, recommendations, a toolbar, A/B tests and much more. In this article you will find the most important information on using it with Purple.
docTags: 
createdAt: 2024-06-25T14:46:19.046Z
---

# Summary

## Official websites

| **Site**      | **URL**                                                                                                    |
| ------------- | ---------------------------------------------------------------------------------------------------------- |
| Website       | [https://www.kilkaya.com/](https://www.kilkaya.com/)                                                       |
| Documentation | [Provided as Google Docs](https://docs.google.com/document/d/1EoNA7NiWWqiTVaPeWkOxAKImaSzdAqzfvq8dGM0DFrs) |

## Developer integrations

| **Platform** | **URL**                                                                                                    |
| ------------ | ---------------------------------------------------------------------------------------------------------- |
| Android      | <font color="#ff6900">not supported</font>                                                                 |
| iOS          | <font color="#ff6900">not supported</font>                                                                 |
| Web          | [Provided as Google Docs](https://docs.google.com/document/d/18heV5xJ0QRdvpgWsA4AHF5htkyPmNMhtB0gHPzt1UOk) |

# Tracking service

## Event support matrix

Overview of the supported events and their configuration.

|                                            | **Templates**                                     | **Parameter**                              |
| ------------------------------------------ | ------------------------------------------------- | ------------------------------------------ |
| <font color="#2166ae">**Actions**</font>\* | <font color="#3b9f0f">*title
type
section*</font> | <font color="#ff6900">not supported</font> |
| <font color="#2166ae">**Views**</font>\*   | <font color="#3b9f0f">*title
type
section*</font> | <font color="#ff6900">not supported</font> |

<font color="#2166ae">**Purchases**</font> and <font color="#2166ae">**Attributes**</font> are not supported.

<font color="#9900ef">(*)</font> <font color="#2166ae">**Actions**</font> and <font color="#2166ae">**Views**</font> contains special handling regarding url tracking. More detailed information can be found below in the description of the event configuration for actions and views.

## General structure in tracking\_config.json

:::hint{type="info"}
Tracking service key name in "*tracking\_config.json*" is:
"<font color="#2166ae">**kilkaya**</font>"
:::

:::CodeblockTabs
General structure

```json
{
  
  "kilkaya": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": true,
    "purchasesEnabledByDefault": false,
    "attributesEnabledByDefault": false,
    
    "events": {
      // your configured list of events
    },
    
    "views": {
      // your configured list of events
    },
    
    "purchases": {},
    
    "attributes": {} 
    
  }
  
}
```
:::

## Event configuration

### Actions

Kilkaya supports action events.&#x20;

:::CodeblockTabs
Action event

```json
"action_event_key": {
  "templates": {
    "title": "value of template",
    "type": "value of template",
    "section": "value of template"
  }
}
```

Example

```json
"ISSUE_DOWNLOADED":{
  "templates":{
    "title": "value of template",
    "type": "value of template",
    "section": "value of template"
  }
}
```
:::

**Kilkayas special behavior for url tracking**

As mentioned in the official documenation of Kilkaya an action event must send the values for "<font color="#3b9f0f">**url**</font>" and "<font color="#3b9f0f">**toUrl**</font>". Both of them are added automatically in Purple Experience. For the case that an action event will not change the view the value of "url" and "toUrl" will be the same.

### Views

Kilkaya supports view events.&#x20;

:::CodeblockTabs
View event

```json
"view_event_key": {
  "templates": {
    "title": "value of template",
    "type": "value of template",
    "section": "value of template"
  }
}
```

Example

```json
"STOREFRONT_FEED": {
  "templates": {
    "title": "value of template",
    "type": "value of template",
    "section": "value of template"
  }
}
```
:::

**Kilkayas special behavior for url tracking**

As mentioned in the official documenation of Kilkaya a view event must send the value for "<font color="#3b9f0f">**url**</font>". This is added automatically in Purple Experience.&#x20;

### Purchases

Kilkaya does not support purchase events.&#x20;

### Attributes

Kilkaya does not support attributes.&#x20;

## Additional supported functionality

No additional functionality is currently supported.

# How to configure&#x20;

## Native Purple App

Kilkaya does not provide any native integration.

## Web integration

### Enable SDK

Kilkaya is not explicitly enabled. If a valid configuration of Kilkaya is present in the "*experience.config.json*", the SDK is integrated into the HTML document.

**Structure in experience.config.json**

:::CodeblockTabs
Plugin configuration

```json
{
  "purple": {
    "analytics": {
    
      "kilkaya": {
        "configuration": {
          "cdnHost": "Provided by Kilkaya",
          "installationId": "Provided by Kilkaya"
        }
      }
      
    }
  }
}
```
:::

### Consent management

If you use one of the CMPs supported by Purple, you must specify the CMP-specific  vendor id for Kilkaya, which you can get from your CMP frontend. Additionally, the IAB vendor id for Kilkaya can also be added.

**Structure in experience.config.json**

:::CodeblockTabs
Plugin configuration with consent

```json
{
  "purple": {
    "analytics": {
    
      "kilkaya": {
        "configuration": {
          "cdnHost": "Provided by Kilkaya",
          "installationId": "Provided by Kilkaya"
        },
        "consent": {
          "vendorId": "",
          "iabVendorId": ""
        }
      }
      
    }
  }
}
```
:::