This documentation provides guidance on how to integrate the June SDK with your Node.js application. June SDK is a powerful library for tracking user interactions and events, offering similar functionality to the underlying Segment SDK.

To install the June SDK in your Node.js project, use the npm package manager:

1
npm install @june-so/analytics-node --save

Alternatively, use yarn:

1
yarn add @june-so/analytics-node

First, you'll need to import the SDK into your application:

1
import { Analytics } from '@june-so/analytics-node';

Next, instantiate the client using the write key you've received when you created your June account:

1
const analytics = new Analytics('YOUR_WRITE_KEY');

Now you can use the analytics instance to track events, identify users, and more.

1
const analytics = new Analytics('YOUR_WRITE_KEY', options);

Example:

1
const analytics = new Analytics('YOUR_WRITE_KEY', {
2
  maxEventsInBatch: 50,
3
  flushInterval: 30000, // flush every 30 seconds
4
});

To track events, you can use the track method:

1
analytics.track({
2
  userId: 'USER_ID',
3
  event: 'Signed In',
4
  properties: {
5
    browser: 'chrome',
6
  },
7
});

Parameters:

To identify users, you can use the identify method:

1
analytics.identify({
2
  userId: 'USER_ID',
3
  traits: {
4
    email: 'test@example.com',
5
    // Optional
6
    name: 'Joe Bloggs',
7
    avatar: 'https://avatar.com/asd809sdhoif9as10nc29.png',
8
    // Add anything else about the user here
9
  },
10
});

Parameters:

To group users by organization or company, use the group method:

1
analytics.group({
2
  userId: 'USER_ID',
3
  groupId: 'GROUP_ID',
4
  traits: {
5
    name: 'Acme Inc',
6
    // Optional
7
    avatar: 'https://avatar.com/asd809sdhoif9as10nc29.png',
8
    // Add anything else about the company here
9
  },
10
});

Parameters:

In serverless environemnts like AWS Lambda, your environment may finish the code execution before June SDK is able to send events to June API.

You can use the flush method to send all queued events to June or you can configure the SDK to flush events automatically.

1
await analytics.closeAndFlush();

If you set flushAt to 1, the SDK will flush events automatically after every event.

1
const analytics = new Analytics('YOUR_WRITE_KEY', {
2
  maxEventsInBatch: 1,
3
});

;