Skip to content

morning-kpi/morning-js

Repository files navigation

Morning Metrics

Do more with your metrics.

Build NPM Version Documentation

Installation

npm install --save morning-js

Usage

Import Library

import { Morning } from 'morning.js';

Initialize Client

const morning = new Morning(`<API KEY>`);

Update Metrics

// Incrementing the base metric
await morning.metrics.increment(`METRIC ID`, 1)
// Incrementing a metric with user data
await morning.metrics.increment(`METRIC ID`, 1, {
	email: 'user@email.com',
	personProperties: {
		name: 'John Smith',
		avatar: 'https://profile.com/image.png',
	}
})

Reading Metrics

const metric = await morning.metrics.get(`METRIC ID`);

Reading Customer Profiles

Reading by id:

const customer = await morning.people.get(`PERSON ID`);

Searching by email or person id:

const customer = await morning.people.search({ email: 'email@domain.com' });
const customer = await morning.people.search({ personId: '123456' });