Skip to content

AdobeAtAdobe/adobe-analytics-di

Repository files navigation

adobe-analytics-di

TrackingImage

Adobe Analytics Data Insertion Module

This node module allows you to push data into your Adobe Analytics reporting suite from the server side. It uses the Data Insertion API to push your data into your reporting suite.

Installation

npm install adobe-analytics-di --save

Example

Setup the Analytics DI API:

var adobeAnalyticsHelper = require('adobe-analytics-di');
adobeAnalyticsHelper.setReportingSuiteId("MY-REPORTING-SUITE-ID");

Send data to Adobe Analytics. Note that the property names are case sensitive because they get used in the XML sent to the DI API:

var callData = {
      visitorID: 'myvisitorId',
      pageName: 'My Home Page',
      channel: 'My Channel name',
      eVar10: 'test evar10 value',
      prop10: 'test prop10 value',
      events: "event10,event11"
    };

var myDi = adobeAnalyticsHelper.getDataInsertion(callData);

if (myDi != null) {
    adobeAnalyticsHelper.sendCallToAdobeAnalytics(myDi);
}

Tests

npm test

Release History

  • 1.0.0 Initial release
  • 1.0.1 Added missing dependency
  • 1.0.2 Updated the README
  • 1.0.3 Updated the README to remove the html formatting from the code section
  • 1.0.4 Updated the keywords
  • 1.1.0 added logging feature
  • 1.2.0 now with 100% more promises
  • 1.2.1 Fix for referrer being overwritten with ReportingSuiteId
  • 1.3.0 Added fixes from Radu and updated testing from Make to use Mocha
  • 1.3.1 Updated to support the latest Insertion API spec. Zoran added the required 'imsregion' property.
  • 1.3.2 Added getters and setters. Thanks to DhrBaksteen for the contribution
  • 1.3.4 Added setter for setting DI service port. Thanks to kevpmoore for the contribution. Also I have updated the default tracking server as suggested in https://github.com/AdobeAtAdobe/adobe-analytics-di/issues/
  • 1.3.6 Updated dependencies, #20 Incorrect validation of mandatory visitorId, #19 pageName shouldn't always be mandatory, #18 Broken Docs Link in Readme