❤
npm
Sign UpSign In

This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

heap-server

1.0.2 • Public • Published

Heap server-side events Build Status

Heap Analytics server-side events helper

Getting Started

Install the module with: npm install heap-server

More info on the Heap documentation site

Methods

The Heap server side API currently has two internal methods:

  • track
  • identify

When you send along an event property with the heap.push() method you will be using the internal track method. If you are not sending an event along you're using the internal identify method.

Example: tracking a custom event

var heap = require('heap-server')('--your-heap-app-id--');
 
heap.push({
  identity: "john@doe.org",
  event: "Custom event name that shows up in Heap Analytics",
  properties: { // extra event properties are optional
    "foo" : "bar"
  }
}, function(err, foo){
  if(err){
    return;
  }
  console.log(foo);
});
 
// or no callback
 
heap.push({
  identity: "john@doe.org",
  event: "Custom event name that shows up in Heap Analytics",
  properties: {
    "foo" : "bar"
  }
});

Example: identifying a new or existing user

You can also use this to update properties for an existing user.

var heap = require('heap-server')('--your-heap-app-id--');
 
heap.push({
  identity: 'john@doe.orgfoobar',
  properties: {
    'foo': 'bar',
    'random': 'bogus'
  }
},
function(err, result){
    if(err){
      return;
    }
    console.log(result);
});
 
 
// or no callback
 
heap.push({
  identity: 'john@doe.orgfoobar',
  properties: {
    'foo': 'bar',
    'random': 'bogus'
  }
});
 

Readme

Keywords

none

Package Sidebar

Install

npm i heap-server

Repository

github.com/anthonyringoet/heap-server

Homepage

github.com/anthonyringoet/heap-server

Weekly Downloads

5

Version

1.0.2

License

none

Last publish

Collaborators

  • anthonyringoet
Try on RunKit
Report malware