---
title: Chartbeat
slug: experience/chartbeat
description: Learn about Chartbeat's official websites, developer integrations, supported events, and configuration. Discover details about the structure of the tracking_config.json file and event configurations for views, while also understanding the limitations on a
docTags: 
createdAt: 2023-06-30T14:37:13.964Z
---

# Summary

## Official websites

| **Site**      | **URL**                                                            |
| ------------- | ------------------------------------------------------------------ |
| Website       | [https://chartbeat.com/](https://chartbeat.com/)                   |
| Documentation | [https://docs.chartbeat.com/cbp/](https://docs.chartbeat.com/cbp/) |

## Developer integrations

| **Platform** | **URL**                                                                                                                                              |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Android      | [https://jitpack.io/#chartbeat/android\_sdk/](https://jitpack.io/#chartbeat/android_sdk/)                                                            |
| iOS          | [https://github.com/chartbeat-labs/chartbeat-ios-sdk](https://github.com/chartbeat-labs/chartbeat-ios-sdk)                                           |
| Web          | [https://docs.chartbeat.com/cbp/tracking/standard-websites/our-javascript](https://docs.chartbeat.com/cbp/tracking/standard-websites/our-javascript) |

# Tracking service

## Event support matrix

Overview of the supported events and their configuration.

|                                        | **Templates**                                               | **Parameter**                              |
| -------------------------------------- | ----------------------------------------------------------- | ------------------------------------------ |
| <font color="#2166ae">**Views**</font> | <font color="#3b9f0f">*name
viewId
authors
sections*</font> | <font color="#ff6900">not supported</font> |

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

## General structure in tracking\_config.json

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

:::CodeblockTabs
General structure

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

## Event configuration

### Actions

Chartbeat does not support action events.

### Views

Chartbeat supports view events.

:::CodeblockTabs
View event

```json
"view_event_key": {
  "templates": {
    "name": "value of template",
    "viewId": "value of template",
    "authors": "value of template",
    "sections": "value of template"
  }
}
```

Example 1

```json
"STOREFRONT_FEED": {
  "templates": {
      "name": "feed",
      "viewId": "/storefront/feed"
  }
}
```

Example 2

```json
"APP_MENU": {
  "templates": {
    "name": "app_menu",
    "viewId": "/app/menu",
    "sections": "menu"
  }
}
```

Example 3

```json
"ISSUE_CONTENT": {
  "templates": {
    "name": "issue",
    "viewId": "/issue/{{ISSUE_ID}}",
    "authors": "author1,author2",
    "sections": "section1,section2"
  }
}
```
:::

**Templates**

| **Templatey key**                     | **Required**                         | **Template value**                                                                                                                                                                      |
| ------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <font color="#3b9f0f">name</font>     | <font color="#eb144c">**yes**</font> | Human readable name of the view. <br />Purple recommends to use **lowercased** text and separated by **underscores**.<br />*Example:*<br />"<font color="#3b9f0f">awesome_event</font>" |
| <font color="#3b9f0f">viewId</font>   | <font color="#eb144c">**yes**</font> | An url path of the view.<br />When using chartbeat for native apps **and** websites, it is recommended to map native views to corresponding urls.                                       |
| <font color="#3b9f0f">authors</font>  | **no**                               | A comma-separated list of authors. <br />If no authors key is found, the authors will be reset for the following view event.                                                            |
| <font color="#3b9f0f">sections</font> | **no**                               | A comma-separated list of sections.<br />If no sections key is found, the sections will be reset for the following view event.                                                          |

### Purchases

Chartbeat does not support purchase events.

### Attributes

Chartbeat does not support attributes.

## Additional supported functionality

No additional functionality is currently supported.

# How to configure

## Native Purple App

Any native Tracking Service is configured in the <font color="#2166ae">**Purple Manager.**</font>

### Enable SDK

:::hint{type="info"}
***Settings location***

"<font color="#2166ae">**Your app**</font>" => "<font color="#2166ae">**Consent/Push/Analytics**</font>" => "<font color="#2166ae">**Analytics (General/iOS/Android/Web)**</font>"
:::

| **Setting**              | **Description**                                                  |
| ------------------------ | ---------------------------------------------------------------- |
| **Enable Chartbeat**     | To enable the Chartbeat SDK in your app, activate this checkbox. |
| **Chartbeat Account ID** | The chartbeat accound id. This value is provided by chartbeat.   |
| **Chartbeat Site ID**    | The chartbeat site id. This value is provided by chartbeat.      |

### Apple privacy / ATT

:::hint{type="info"}
***Settings location***

"<font color="#2166ae">**Your app**</font>" => "<font color="#2166ae">**Consent/Push/Analytics**</font>" => "<font color="#2166ae">**Privacy**</font>"
:::

### Consent management

:::hint{type="info"}
**Settings location:**

"<font color="#2166ae">**Your app**</font>" => "<font color="#2166ae">**Consent/Push/Analytics**</font>" => "<font color="#2166ae">**Consent Management**</font>"
:::

| **Setting**                 | **Description**                                               |
| --------------------------- | ------------------------------------------------------------- |
| **Vendor-ID for Chartbeat** | The Vendor-ID is provided by the consent management platform. |

## Web integration

### Enable SDK

Chartbeat is not explicitly enabled. If a valid configuration of Chartbeat 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": {
    
      "chartbeat": {
        "configuration": {
          "accountId": "Provided by Chartbeat",
          "siteId": "Provided by Chartbeat"
        }
      }
      
    }
  }
}
```
:::

### Consent management

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

**Structure in experience.config.json**

:::CodeblockTabs
Plugin configuration with consent

```json
{
  "purple": {
    "analytics": {
    
      "chartbeat": {
        "configuration": {
          "accountId": "Provided by Chartbeat",
          "siteId": "Provided by Chartbeat"
        },
        "consent": {
          "vendorId": "",
          "iabVendorId": ""
        }
      }
      
    }
  }
}
```
:::