puma-client

Usage Analytics Client for Products

Library

Initialization

import { mkPumaClient, IPumaConfig } from "puma-client";

const config: IPumaConfig = {
    session_id: "9b1deb4d3b7d4bad9bdd2b0d7b3dcb6d", // Required
    url: "http://localhost:8001/data", // Required
    product_name: "product_name", // Required
    subdomain: "subdomain", // Required
};

const client = mkPumaClient(config);

API

Page View Data

import { mkPageViewData } from "puma-client";
const pageviewData = client.sendPageViewData(mkPageViewData());

Impression Data

import { mkImpressionData } from "puma-client";
const impressionData = client.sendImpressionData(
    mkImpressionData(req, async () => {
        const data = await findIP();
        return data;
    })
);

Web

<script src="/path/to/puma-client-<version>.js"></script>
<script>
    const client = PumaClient.mkPumaClient({
        session_id: "9b1deb4d3b7d4bad9bdd2b0d7b3dcb6d", // Required
        url: "http://localhost:8001/data", // Required
        product_name: "product_name", // Required
        subdomain: "subdomain", // Required
    });

    // Page View Data
    const pageviewData = PumaClient.mkPageViewData();
    client.sendPageViewData(pageviewData);
</script>