lawg.js

Initialization

const lawg = new Lawg({
  token: process.env.LAWG_TOKEN,
  project: "my_cool_project",
  ua: req.headers["user-agent"], // Optional
});

Events

Fetching all Feed Events

await lawg.feed("orders-shipped").fetchEvents();

Creating a Event

await lawg.feed("orders-shipped").event({
  title: "Order Shipped",
  description: "John's order has been shipped! (Order #10403)",
  emoji: "🚚", // or :truck:
  metadata: {
    ua: req.headers["user-agent"], // Optional (overides UA set in initialization)
    tags: {
      "customer-id": 1234,
      "customer-email": "[email protected]",
    }, // Optional
  },
  notify: true, // Optional (defaults to false)
  timestamp: "2023-06-22T13:42:55.789Z", // Optional
});

Updating a Event

await lawg.feed("orders-shipped").editEvent({
  id: "log_xxxxxxxxxxxxxx",
  title: "Order Returned",
  description:
    "John's order has been returned, it will no longer ship! (Order #10403)",
  emoji: "🚚", // or :truck: (Optional)
  metadata: {
    tags: {
      "customer-id": 1234,
      "customer-email": "[email protected]",
    }, // Optional
  },
  timestamp: "2023-06-15T13:42:55.789Z", // Optional
});

Deleting a Event

await lawg.feed("orders-shipped").deleteEvent({
  id: "log_xxxxxxxxxxxxxx",
});

Insights

Creating a Insight

await lawg.insight({
  title: "Users Joined",
  emoji: "👤" // or :bust_in_silhouette: (Optional)
  value: 250,
});

Updating a Insight

You may set emoji: ":your_emoji:" in any of the fields below when updating an insight (optional).

Setting a Insight's Value

await lawg.setInsight({
  id: "insight_xxxxxxxxxxxxxx",
  set: 150, // Overides initial value (Now: 150, Before: 250)
});

Incrementing a Insight

Positive Increments

await lawg.incInsight({
  id: "insight_xxxxxxxxxxxxxx",
  increment: 150, // Increments initial value (Now: 400, Before: 250)
});

Negative Increments

await lawg.incInsight({
  id: "insight_xxxxxxxxxxxxxx",
  increment: -150, // Increments initial value (Now: 0, Before: 250)
});