Get up and running with Chartbeat—full implementation guides for all our products.

Integrations

Mobile Web Apps

If you're interested in using Chartbeat to track your audience inside a native iOS or Android app, please reach out to your Customer Success Manager or to the Chartcorps team at support@chartbeat.com to learn more.

If you want to track pages that are part of a web app, and not a native app, simply add the following additional config variable to the existing Chartbeat code in the body:

_sf_async_config.mobileApp = true;

Slack Integration

After you connect your company's Slack with your Chartbeat Publishing account you'll start receiving updates and alerts as they happen and be able to use unique Chartbeat slash commands to ask real-time questions about your content's performance.

Installation

If your Chartbeat login has the role of 'Admin', you’ll be able to set up the integration. If you’re not sure who the account admin is at your organization, drop a note to your Customer Success Manager or to the Chartcorps team at support@chartbeat.com, and they’ll be able to help you out.

If you’re the admin, first head over to the new Integrations tab in your Settings page at https://chartbeat.com/publishing/settings/integrate/.

Slash Commands

Use the slash command /chartbeat to get traffic updates directly from Chartbeat. If you’re not familiar with Slack’s slash commands, check out Slack's support doc.

The basic structure for the /chartbeat command is as follows, but is completely customizable to reflect your site’s unique sections, authors, and more:

/chartbeat METRIC on HOST where FILTER is FILTER_VALUE

Some examples would be:

/chartbeat what are the top pages on yourdomain.com
/chartbeat how many people are currently on yourdomain.com
/chartbeat how much traffic is on stories where section is business
/chartbeat how much traffic on yourdomain.com was referrered by facebook.com
/chartbeat how much traffic on yourdomain.com is from social sources

Metrics

Top Pages A list pages on your site with the highest number of concurrents.
Concurrents The number of visitors on a given page or domain in real-time.
Average Engaged Time The average amount of time in seconds visitors actively spends on a page.

Filters

Referrer The referring domain.
Author The author of a page.
Section The section of a site visited (Unique to your domain).
Page Path The reported path of the page (Unique to your domain).
Referrer Type The page referrer type: social, search, or direct.
New Users Users that are visiting a given domain for the first time in 30 days.

Real-Time Updates

Once users have integrated Chartbeat with their Slack account they can create push notifications to be posted directly in Slack channels when noteworthy events occur.

Spike Alerts

Customers who have integrated Chartbeat with Slack will now have the option to receive Spike Alerts in a selected Slack channel. To configure customers will just have to enable "Slack messaging" and select which channel the spike alert should post to.

Report Builder

Report Builder customers can setup "Report Complete" push notifications through their Report Builder Settings Page.

AMP Integration

Getting Started

Google’s Accelerated Mobile Pages (AMP) project aims to speed up load times on mobile web pages, industry-wide, using a special, lightweight form of HTML. As a part of this AMP project, Google has been updating its search results to point to an AMP page—if it exists—in its mobile search results.

Because many mobile users exit publisher websites before a page finishes loading because of slow or erratic load times, building mobile pages with AMP can improve user experience, retain readership, and built loyalty.

Once a Chartbeat Dashboard is integrated with AMP tracking, a new field will appear under the Site Experience section on the left-hand side of the Dashboard, called 'AMP'. This will display the percentage of concurrents that are engaging with the content that you've built using the AMP technology.

Additionally, by selecting the AMP Site Experience category you'll filter the entire Dashboard to only show you the concurrents who are engaging with your AMP content-as well as all the Chartbeat metrics specific to that group.

If you're interested in integrating Chartbeat into your AMP pages to track real-time data on those readers first be sure you’ve completed these requisite steps before moving forward:

  1. You must be a current Chartbeat Publishing client with Chartbeat code already successfully implemented on your site.
  2. You must know your UID number. If you don't know your UID, head over to chart.bt/setup and enter the domain you're tracking into the feild and select 'generate code'. In the generated code block, your UID will be auto-filled in line 4.
  3. You need a validated and functioning AMP page where Chartbeat AMP code can be included.

Chartbeat and AMP

Part 1: After testing the AMP markup in your pages and confirming it is working correctly, you’ll need to add the "amp-analytics.js" extension within the <head> of the AMP page markup code. This will enable analytics on your AMP pages.

<script async custom-element="amp-analytics" src="https://cdn.ampproject.org/v0/amp-analytics-0.1.js"></script>

Part 2: Add this code to the <body> of your AMP webpage to define the Chartbeat variables and tracking data for the page.

<amp-analytics type="chartbeat">
    <script type="application/json">
        {
            "vars": {
                "uid": "12345",
                "domain": "yoursite.com",
                "sections": "section 1, section 2"
                // Author, etc.
            }
        }
    </script>
</amp-analytics>

As all third-party JavaScript sources behave differently on AMP pages, if you are using custom metadata fields to populate the sections, authors, and content type variables in your existing Chartbeat code, you'll need to retrieve these outside of the AMP markup.

Your UID for your Chartbeat account and the domain variables should be set manually as they are static and will not change from article to article.

The full list of variables that you can include in your AMP Chartbeat markup are:

Note: Be sure to double check your work and ensure there is no trailing comma at the end of the final key-value pair (example: see above after the "sections": "section1, section 2"). Testing in AMP code has shown that this will break the functionality of pings coming from your AMP pages.

Once the variables are set, you can insert the code into the AMP article <body>. Your AMP markup is ready to be published.

Important Notes

Because Google restricts the use of JavaScript in its supported AMP partners' analytics and advertising scripts, we are currently unable to classify a visitor to your site's AMP pages as new, returning, or loyal in real-time products. All AMP page visitors will appear to be "returning" vistors in Chartbeat products.

Troubleshooting

If you've implemented the Chartbeat AMP code and you're still seeing an error, we'd love to help troubleshoot.

So that we can best help you, send us an email at support@chartbeat.com with:

  • your account information (including UID)
  • a description of the problem you're seeing
  • and the URL of the AMP page you've implemented on

Our Chartcorps support team will dig into the code and help uncover the problem.

Facebook Instant Articles Integration

Getting Started

Facebook's Instant Articles are HTML documents optimized for fast mobile performance that was launched to publishers globally on April 12, 2016.

Once a Chartbeat Dashboard is integrated with Facebook Instant Articles, a new field will appear under the Distribution section on the left-hand side of the Dashboard, called 'Facebook IA'. This will display the percentage of concurrents that are engaging with your Facebook Instant Article content.

Additionally, by selecting the Facebook IA distribution channel you'll filter the entire Dashboard to only show you the concurrents who are engaging with your instant article content-as well as all the Chartbeat metrics specific to that group.

If you're interested in integrating Chartbeat into your FIA pages to track real-time data on those readers first be sure you’ve completed these requisite steps before moving forward:

  1. You must be a Chartbeat customer with code already implemented on your website.
  2. You'll need a validated and functioning Facebook Instant Article page where Chartbeat analytics can be included in the FIA-analytics iframe and confirmed as working before rolling out to the rest of your pages.
  3. Please note that Chartbeat's Instant Article integration is not compatible with tag managers.

Chartbeat and FIA Implementation

Include an iframe on your article using the Analytics element, as shown below. Please be sure that this embed is included in the <body> of the article - FIA does not support tracking in the header or footer.

<figure class="op-tracker">
  <iframe>
    <!-- Include full analytics code here -->
  </iframe>
</figure>

Please remember that if you're using a custom metadata field or data layer to populate sections, authors, and content type in your existing Chartbeat code, you will not be able to retrieve these inside the FIA code, as JavaScript cannot be used this way in FIA.

Your UID for your Chartbeat account and the domain variables should be set manually as they are static and will not change from article to article.

The full list of variables that you can include in your FIA Chartbeat markup are:

Checking your Work The code you insert into the <figure class="op-tracker"></figure> should look similar to this:

<figure class="op-tracker">
  <iframe>
	<script type='text/javascript'>
	    var _sf_async_config = {};
	    /** CONFIGURATION START **/
	    _sf_async_config.uid = 1234; /*CHANGE TO YOUR ACCOUNT NUMBER */
	    _sf_async_config.domain = 'domain.com'; /*CHANGE TO YOUR DOMAIN*/
	    _sf_async_config.title = cms.title.variable; /* CHANGE TO YOUR TITLE */
	    _sf_async_config.sections = ''; /* UPDATE WITH YOUR SECTION LOGIC */
	    _sf_async_config.authors = ''; /* UPDATE WITH YOUR AUTHOR LOGIC */
	    _sf_async_config.type = ''; /*OPTIONAL FOR REPORT BUILDER RETURN */
	    _sf_async_config.path = ''; /*OPTIONAL SPECIFIC PATHS */
	    _sf_async_config.useCanonical = true; /*AGGREGATES AUDIENCE TRACKING */
	    /** CONFIGURATION END **/
	    window._sf_endpt = (new Date()).getTime();
	</script>
	<script defer src="//static.chartbeat.com/js/chartbeat_fia.js"></script>
  </iframe>
</figure>
              	

Important Notes

Facebook's use of iframes within Facebook Instant Articles can restrict some of the data that analytics vendors like Chartbeat can ordinarily record:

  • In the case where a reader moves from one of your own FIA articles to an article on your web domain, they would be classified with the "m.facebook.com" referrer.
  • We're currently unable to support video tracking within Facebook Instant Articles, and recommend that customers who wish to use third-party video player embeds in FIA content disable Chartbeat video tracking within their FIA articles.
  • Additionally we may not fully collect referrer information from users accessing FIA articles on some Andoid devices.

Troubleshooting

  1. Be sure that pinger code script tag is set to chartbeat_fia.js.
  2. Check to see that the h-key contained in a ping is explicitly set to your domain - not including "www." or "http://".
  3. If you're seeing the path as the title in your dashboard, make sure that you've set the _sf_async_config.title in your FIA implementation
  4. In addition, if you are tracking campaigns with specific UTM parameters in FIA (which is not recommended) - set the Chartbeat useCanonical variable to true and ensure that the FIA og:url is canonical.

If you've implemented the Facebook Instant Article code and you're still seeing an error, send us an email at support@chartbeat.com with:

  1. your account information (including UID)
  2. a description of the problem you're seeing
  3. and the URL of the FIA page you've implemented on

Our Chartcorps support team will dig into the code and help uncover the problem.

Offsite Social powered by Crowdtangle

Introduction

Powered by CrowdTangle and available to clients of both CrowdTangle and Chartbeat Publishing, Offsite Social gives journalists, editors, and social media editors an expanded view of article performance so they can understand how the articles they write are read and distributed on social platforms.

The Offsite Social feature tackles that social gap for those seeking to understand and act on the link between content performance on their site and across top social platforms (Facebook, Twitter, Instagram, Youtube, Vine, and Reddit).

For more information on how to use this feature, check out this orientation video and these FAQs.

Implementation

The Offsite Social feature is available to all Chartbeat Publishing clients that are also Crowdtangle customers. For customers who meet that requirement, there is no additional implementation required.

If you are both a client of Chartbeat Publishing and Crowdtangle, simply reach out to your Customer Success Manager, or the Chartcorps support team at support@chartbeat.com and they can help you get it switched on.

Looking for something else? We’re happy to help.