NestJS — Analytics and Feedback

​

Analytics

import { Injectable } from '@nestjs/common';
import { LerixService } from '@lerix-dev/lerix-nestjs';

@Injectable()
export class OrdersService {
  constructor(private readonly lerix: LerixService) {}

  async markPaid(order: Order) {
    // ...
    this.lerix.track('payment_succeeded', { plan: 'pro', amount: 49 }, { userId: order.userId });
  }
}

• userId is your own ID for the user, the same one your apps pass to setUser(). Leave it out for events that aren’t about a user.
• Names start with a letter, then letters, digits, spaces, _, ., : or - (2 to 64 characters). Up to 25 properties, with string (up to 1,024 characters), finite number, boolean or null values. An invalid name drops the event; an invalid property is dropped on its own. track() never throws.
• Server events record no sessions or screens.

​

Delivery

​

Environment and opt-out

this.lerix.analytics.setEnabled(false); // stop recording and clear the buffer

​

Feedback

const id = await this.lerix.feedback.submit({
  message: 'Checkout button does nothing',
  email: 'user@example.com',           // optional, used for email replies
  labels: ['bug'],                     // label keys configured for the project
  userId: user.id,                     // optional, your ID for the user
  custom: { plan: 'pro' },             // optional, up to 50 keys / 16 KB
  attachments: [{ data: pngBytes }],   // optional, up to 5 PNG/JPEG/WebP images of 5 MB
});

• Attachments are uploaded first, then the feedback is created with their IDs.
• A failed request is retried twice with the same client ID, so a retry never creates a duplicate.
• submit() rejects with LerixApiException: code INVALID_FEEDBACK for input that can’t be sent (an empty or too long message, an invalid email, an attachment that isn’t a PNG, JPEG or WebP image), or the API’s error otherwise. With enabled: false it resolves null.
• Inside a traced request, the feedback is linked to the request’s trace.