@livechat/store-metrics NPM

@livechat/store-metrics

Reads and stores various marketing parameters in Accounts Client Store. Super Important Thing for Marketing Team™. Only 3.1kB gzipped.

Installation

npm install --save @livechat/store-metrics

Usage

Apps

Library exposes only one function that saves source attribution and Partner Program affiliation params based on document.location and document.referrer. Make sure to fire it as early as possible, before redirects etc.

import storeMetrics from "@livechat/store-metrics";
storeMetrics();

Websites

For websites without module bundler/resolver you can use self-executing version of store-metrics. You can load it directly from our CDN:

<script src="https://cdn.livechat-static.com/metrics/store-metrics.min.js" async></script>

And that's it.

Development

npm install
npm run test:watch

Build

npm run build

Testing locally

Make sure it is already built. Then run:

http-server -p 8000

It requires http-server to be installed. Go to http://localhost:8000/example.html?param1=value1&param2=value2 to test how params are handled.

Changelog

1.1.5 — 2024-09-06

Added

Resetting partner_id if param not found in url
Enabling debug mode for all environments (temporary for testing, to be removed later)

1.1.4 — 2024-08-14

Added

Regexes for Marketplace in whitelisted urls

1.1.3 — 2024-08-08

Added

Debug mode extended for urls containing development keyword

1.1.2 — 2024-08-08

Fixed

Fixed regexes for whitelisted urls

Added

Debug mode for labs/staging environments

1.1.0 — 2024-07-08

Added

Resetting partner_id

1.0.0 — 2021-05-25

Changed

Storage mechanism changed from cookies to cross-domain localStorage, to support multi-product Global Accounts
Because there is no 'session' concpet in localStorage, default TTL is set to 2 weeks