Chartbeat

18min

Summary
Official websites
Site
URL
Website
﻿https://chartbeat.com/﻿
Documentation
﻿https://docs.chartbeat.com/cbp/﻿
Developer integrations
Platform
URL
Android
﻿https://jitpack.io/#chartbeat/android_sdk/﻿
iOS
﻿https://github.com/chartbeat-labs/chartbeat-ios-sdk﻿
Web
﻿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
﻿Views﻿
﻿name
viewId
authors
sections﻿
﻿not supported﻿
﻿Actions, Purchases and Attributes are not supported.
General structure in tracking_config.json
Tracking service key name in "tracking_config.json" is:
"chartbeat"
General structure
{
  
  "chartbeat": {
    "eventsEnabledByDefault": false,
    "viewsEnabledByDefault": true,
    "purchasesEnabledByDefault": false,
    "attributesEnabledByDefault": false,
    
    "events": {},
    
    "views": {
      // your configured list of events
    },
    
    "purchases": {},
    
    "attributes": {} 
    
  }
  
}
{
  
  "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.
View event
Example 1
Example 2
Example 3
"view_event_key": {
  "templates": {
    "name": "value of template",
    "viewId": "value of template",
    "authors": "value of template",
    "sections": "value of template"
  }
}
"view_event_key": {
  "templates": {
    "name": "value of template",
    "viewId": "value of template",
    "authors": "value of template",
    "sections": "value of template"
  }
}
﻿
Templates
Templatey key
Required
Template value
﻿name﻿
﻿yes﻿
Human readable name of the view. 
Purple recommends to use lowercased text and separated by underscores.
Example:
"awesome_event"
﻿viewId﻿
﻿yes﻿
An url path of the view.
When using chartbeat for native apps and websites, it is recommended to map native views to corresponding urls.
﻿authors﻿
no
A comma-separated list of authors. 
If no authors key is found, the authors will be reset for the following view event.
﻿sections﻿
no
A comma-separated list of sections.
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 Purple Manager.﻿
Enable SDK
Settings location
"Your app" => "Consent/Push/Analytics" => "Analytics (General/iOS/Android/Web)"
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
Settings location
"Your app" => "Consent/Push/Analytics" => "Privacy"
Consent management
Settings location:
"Your app" => "Consent/Push/Analytics" => "Consent Management"
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
Plugin configuration
{
  "purple": {
    "analytics": {
    
      "chartbeat": {
        "configuration": {
          "accountId": "Provided by Chartbeat",
          "siteId": "Provided by Chartbeat"
        }
      }
      
    }
  }
}
{
  "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
Plugin configuration with consent
{
  "purple": {
    "analytics": {
    
      "chartbeat": {
        "configuration": {
          "accountId": "Provided by Chartbeat",
          "siteId": "Provided by Chartbeat"
        },
        "consent": {
          "vendorId": "",
          "iabVendorId": ""
        }
      }
      
    }
  }
}
{
  "purple": {
    "analytics": {
    
      "chartbeat": {
        "configuration": {
          "accountId": "Provided by Chartbeat",
          "siteId": "Provided by Chartbeat"
        },
        "consent": {
          "vendorId": "",
          "iabVendorId": ""
        }
      }
      
    }
  }
}
﻿
﻿

Site	URL
Website	https://chartbeat.com/
Documentation	https://docs.chartbeat.com/cbp/

Platform	URL
Android	https://jitpack.io/#chartbeat/android_sdk/
iOS	https://github.com/chartbeat-labs/chartbeat-ios-sdk
Web	https://docs.chartbeat.com/cbp/tracking/standard-websites/our-javascript

	Templates	Parameter
Views	name viewId authors sections	not supported

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

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.

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

Updated 19 Jul 2024

Did this page help you?

Braze

Cleverpush