LogoLogo
Chartbeat DocsHelp CenterContact
  • Datastream Documentation
  • Getting Started
    • What is Datastream?
    • Use Cases
    • How it Works
    • Metrics and Dimensions
    • Playbooks and Code Examples
      • Datastream with Redshift
      • Datastream with BigQuery
  • Implement Tracking
    • Basic Tracking
    • ID Sync
  • Destination Setup
    • Amazon S3
    • Google Cloud Storage
  • Chartbeat Docs
  • Help Center
  • Contact Support
  • Back to Chartbeat.com
Powered by GitBook
On this page
  • Recommended integration: ID Sync
  • Implementation for standard website
  • Implementation for native app SDKs
  • Reserved Keys

Was this helpful?

  1. Implement Tracking

ID Sync

PreviousBasic TrackingNextAmazon S3

Last updated 9 months ago

Was this helpful?

Recommended integration: ID Sync

Chartbeat allows customers to send through custom data and fields in the form of a key value pair to link to other products or data sets in your ecosystem.

For example, with ID Sync you can parse your Google Analytics ID from your Google Analytics cookie and link it to our ID Sync variable in your Chartbeat code, then your Datastream data will contain your Charbeat data along with your GA ID as an additional data column in your feed. This data can now be easily mapped to and queried with all your GA data sources to get a comprehensive overview of all your data and help your that help inform company-wide goals.

Some of the common use cases of ID Sync include:

  • Parse IDs from other products: Google Analytics, Adobe Analytics, Data Management Platforms (DMPs), content management system (CMS), Ad platforms etc.

  • Customer IDs: You can send us a unique (defined in your system) customer identifier such as a hashed email ID or subscriber ID.

  • Page IDs: For websites that have unique Page IDs, this field would help you track sessions across different pages and match it with your CMS data.

With ID Sync, website owners can populate their Datastream feed with unlimited custom ID values via a few extra lines of JavaScript in our tracking snippet for standard websites.

Note: this additional JavaScript tracking configuration variable is supported by our tracking integration for standard websites and our native SDKs. It is not currently supported in our AMP integrations.

When you send Chartbeat custom data through ID Sync, this information will appear in your Datastream data feed files as id_sync. If using one of our reserved keys, that data will appear under ga_client_id or login_id () .

Implementation for standard website

Adding custom metadata through ID Sync is simple. Within either the for the Chartbeat tracker or in the loadChartbeat() function, specify the following:

_sf_async_config.idSync = _sf_async_config.idSync || {}; 
_sf_async_config.idSync.KEY_NAME = VALUE;

Note that the idSync variable specified above is a JavaScript Object, not a string, so be sure to specify it as such.

Implementation for native app SDKs

Android SDK

In order to send custom data you will have to instantiate HashMap and add key pair values.

Java:

private void setCustomData(){
  final HashMap<String, String> customData = new HashMap<>();
  customData.put("ga", "286243809.1415748215");
  customData.put("l", "login-id-123");
  customData.put("customKey1", "customValue1");
  Tracker.setCustomData(customData);
}

iOS SDK

CBTracker.shared().idSync = ["ga":"286243809.1415748215", "l":"login-id-123","customKey1":"customValue1"]

Reserved Keys

There are two keys in the idSync object which Chartbeat reserves for special use:

  • Login ID (idSync.l) - A way to uniquely identify a user. You can set this to any value you would like, but we recommend you use a persistent ID that will not change. This data will be accessible via the login_id column of your Datastream feed files.

Getting the GA Client ID from the cookie

Google recommends that you not directly access the cookie analytics.js sets, as the cookie format might change in the future. Instead, you should use the readyCallback to wait until analytics.js is loaded, and then get the clientId value stored on the tracker.

ga(function(tracker) { 
   _sf_async_config.idSync.ga = tracker.get('clientId');
});

If using our or , please follow the instructions below to send custom data through ID Sync.

Note: ga and l are reserved keys ().

Note: ga and l are reserved keys ().

Google Analytics Client ID (idSync.ga) - This user’s . Used by Google Analytics to identify if different browser sessions came from the same user. This data will be accessible via the ga_client_id column of your Datastream feed files.

Android
iOS SDK
see below
see below
Google Analytics Client ID
Data Science and BI teams can create custom analyses
initial setup code
see below