Skip to main content

How do I create Chartbeat data sources?

Updated

You can set up a connection between Klipfolio® Klips and your Chartbeat data to display your digital publishing metrics on a dashboard.

This article includes:

What options do I have for visualizing my Chartbeat data?

Create data visualizations based on pre-built options or build your own. The choice is yours!

Pre-built by Klipfolio

Take advantage of our pre-built data sources to gather the data most meaningful to you.

  • Chartbeat pre-built data sources: Data sources provide the foundation for Klip® building, so we suggest you create a data source as a first step (before building Klips™ and adding them to your dashboard). Our pre-built data sources focus on the most sought-after Chartbeat data and are found on the Service Connectors page, available from this link or from your list of data sources. When you select a service connector from this page, the data source for that service is automatically added.

Custom-built by you

Taking the time to learn how to create your own data sources and Klips unlocks your data and enables you to control, manipulate, and transform it, leading you to unprecedented insights into your business.

  • Custom data sources: When you create a custom data source, you can either use the pre-built data source as a starting point from which to write your own query or you can write your own queries from the ground up and build a data source from scratch. You create custom-built data sources in the Service Connectors page, accessible from this link or from your list of data sources.
  • Custom Klips: Using our Klip Editor, you can construct and manipulate your data, including integrating multiple data sources, to produce unique, custom-built data visualizations. You create custom Klips from either your list of Klips or your Dashboard.

Regardless of whether you choose pre-built, custom-built, or a combination of both, before you can start building Klips and dashboards you need to connect to Chartbeat data in Klipfolio.

How do I connect to Chartbeat data in Klipfolio?

To connect your Chartbeat data to Klipfolio, you will need your API Key and Host Domain.

To get the right data from Chartbeat, you use your Chartbeat API Key and Host Domain in the queries provided by Klipfolio or in your own query when building data sources.

How do I find my Chartbeat API Key and Host Domain?

You can find your API Key and Host Domain in your Chartbeat account. For more information on where to find your API Key and Host Domain, refer to the Chartbeat API Documentation.

How do I add a Chartbeat pre-built data source?

To add a Chartbeat pre-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Chartbeat from the list.
  2. Select a pre-built data source from the left section of the Choose a pre-built or custom connection page.
  3. On the Configure your data source page, enter your Chartbeat API Key and Host Domain.
  4. Click Get data or, if you want to modify the pre-built data request, click Switch to Custom settings.
    Note: If you switch back to the Basic settings page after making changes in the Custom settings page, your changes will not be saved.
  5. Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
  6. Click Continue.
  7. Name, choose refresh settings, and, optionally, share your data source.
  8. Click Save.

If you clicked Switch to Custom settings:

  1. On the Configure your data source page, modify the Query URL to get the data you want. You can use the existing information in the Query URL text box as a base. It was auto-filled based on the pre-built data source you selected on the Choose a pre-built or custom connection page.
  2. Click Get data.
  3. Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
  4. Click Continue.
  5. Name, choose refresh settings, and, optionally, share your data source.
  6. Click Save.

How do I create a Chartbeat custom-built data source?

To create a Chartbeat custom-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Chartbeat from the list.
  2. On the Choose a pre-built or custom connection page, click Create a custom Chartbeat data source.
  3. Adjust the Query URL information, as noted on the Configure your data source page, to replace any generic placeholder query information with your own.
    For example, replace <yourAPIKey> with your own API Key.
  4. Edit the Query URL to return the data you need. Refer to the Chartbeat API documentation for details.
  5. Click Get data.
  6. Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
  7. Click Continue.
  8. Name, choose refresh settings, and, optionally, share your data source.
  9. Click Save.

How do I create a Chartbeat custom Klip?

You create custom Klips from either your list of Klips or your Dashboard. You choose a data visualization format, for example, a pie chart, gauge, or table, and decide whether you want to use an existing data source or create a new one. In the Klip Editor, there are limitless opportunities to modify, relate, and display your data. See the following related articles for more information and get building!

More about Chartbeat's API and queries

Klipfolio connects to hundreds of services in the cloud that have a REST API. If you take the time to learn your service’s API to create queries for the data you want, your possibilities are endless. Here’s a quick overview video on APIs and Klipfolio:

Klipfolio API's 101

If you need assistance using APIs, enlist a data analyst or developer.

Refer to the Chartbeat API documentation to discover more data requests.

See the reference table below for API related information and sample queries.

API Documentation Chartbeat API documentation
Authentication Method API Key Authentication
Response Format JSON
Sample Queries

To get a list of top referrers for your site:

http://api.chartbeat.com/live/referrers/v3/?apikey=<yourAPIKey>&host=<yourSubdomain>

To get the top 5 videos on your site:

http://api.chartbeat.com/live/video/videos/v1/?apikey=<yourAPIKey>&host=<yourSubdomain>&limit=5

Related articles

Related articles