@atados/analytics-sdk

SDK Oficial para Javascript

Está SDK é utilizada para enviar eventos à API de Analytics da Atados

Instalando

yarn add @atados/analytics-sdk

Antes de começar, entenda a função track

track(
  /**
   * Tipo: String
   * Use para categorizar esta acao
   * Ex.:
   *   category = 'Apply',
   *   category = 'Notification',
   */
  category: string,
  /**
   * Tipo: String
   * Use para identificar esta ação dentro da categoria
   * Ex.:
   *   label = 'Cancel Apply',
   *   label = 'View Notification',
   */
  label: string,
  /**
   * Use para enriquecer esta ação dentro da categoria
   * Ex.:
   *   action = ID de inscricao
   *   action = { notificationId, notificationKind }
   */
  action: any,
  /**
   * Use este argumento para sobrepor as configurações de userId
   * ou meta
   */
  overrideConfig?: {
    userId?: string | null
    meta?: Record<string | number, any>
  },
): Promise<void>

Iniciando

import { initAnalytics } from '@atados/analytics-sdk'

const analytics = initAnalytics({
	apiURL: '<api-url>',
	apiToken: '<app-token>',
	// (opcional) Forneça mais informações ao evento
	// Ex.: Canal, Ambiente, etc...
	meta: {},
	fetch,
})

analytics.identifyUser('<userId>')

Utilizando

analytics.track('Category', 'Label', 'Action')