Giter Club home page Giter Club logo

hapi-campaigns's Introduction

hapi-campaigns

A hapi server plugin that provides automatic tracking of campaigns and UTM campaigns

installation

Go to your project directory and do

npm install hapi-campaign

Register the plugin with your hapi server with

const hapiCampaigns = require('hapi-campaigns');
const server = new hapi.Server({ port: 8000 });
await server.register(hapiCampaigns);

How it Works

hapi-campaigns parses every incoming request to your server for a campaign (or utm_campaign) cookie. It will automatically extract any values associated with the campaign cookie (separated by '_'), and for utm_campaigns will extract utm_medium / utm_source fields. It also registers a 'campaign' event that is called any time a campaign matching the specified cookie name is detected.

Example

If you register an event handler like:

server.events.on('campaign', (data) => {
  console.log(data.hello);
});

When you call the route /foo?campaign=visit_world your server will print: "world"

Options

  • cookieName

The cookie associated with your campaign, default value is campaigns64

  • cookie

  • ttl

The TTL for the cookie, by default the cookie will last 30 days.

A JSON object specifying the cookie's properties, these along with their defaults are:

  • isSecure: false
  • isSameSite: false
  • isHttpOnly: true
  • clearInvalid: true
  • ignoreErrors: true

hapi-campaigns's People

Contributors

orthagonal avatar dawnerd avatar

Watchers

Greg Allen avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.