Skip to main content

Eventos de Survey

O SDK notifica seu app a cada evento da pesquisa — impressão, resposta, minimizar, envio, fecho — através de um listener opcional. Use-o para espelhar o funil no seu próprio analytics ou para reagir no app (ex.: dar um brinde depois que o usuário responde um NPS).

Registrar (ou não) um listener não afeta a coleta de dados da GoAB — o listener é só uma cópia dos eventos para o seu app.

Registrar e remover​

import type { SurveyAnalyticsEvent } from '@goab_ltda/survey-sdk-react-native';
import { SurveyEventType } from '@goab_ltda/survey-sdk-react-native';

const listener = (event: SurveyAnalyticsEvent) => {
switch (event.eventType) {
case SurveyEventType.SURVEY_IMPRESSION:
analytics.track('survey_shown', { survey_id: event.surveyId });
break;
case SurveyEventType.SURVEY_SUBMIT:
analytics.track('survey_completed', { survey_id: event.surveyId });
break;
case SurveyEventType.QUESTION_ANSWER:
analytics.track('survey_question_answered', {
survey_id: event.surveyId,
question_id: event.questionId,
question_type: event.questionType,
answer: (event.answer as string[] | null)?.join('|'),
});
break;
default:
break;
}
};

surveySdk.addOnSurveyEventListener(listener);

// ao desmontar / no logout:
surveySdk.removeOnSurveyEventListener(listener);
  • Vários listeners podem coexistir.
  • O mesmo objeto função não é registrado duas vezes (compare por referência — uma arrow function nova a cada render conta como um listener novo).
  • Uma exceção lançada dentro do seu callback é capturada pelo SDK — não derruba a pesquisa nem os outros listeners.
  • Remova o listener no fim do ciclo de vida (logout, useEffect cleanup) para não vazar referência de componente:
useEffect(() => {
const listener = (event: SurveyAnalyticsEvent) => {
/* ... */
};
surveySdk.addOnSurveyEventListener(listener);
return () => surveySdk.removeOnSurveyEventListener(listener);
}, []);

OnSurveyEventListener​

type OnSurveyEventListener = (event: SurveyAnalyticsEvent) => void;

Aceita qualquer função com essa assinatura. O único parâmetro é sempre um SurveyAnalyticsEvent.

SurveyAnalyticsEvent​

Um evento da pesquisa. Nem todo campo é preenchido em todo evento — veja a coluna correspondente na tabela de tipos.

CampoTipoDescrição
eventTypeSurveyEventTypeO tipo do evento (ver abaixo). Sempre presente.
surveyIdnumber | nullID da pesquisa. Presente em todos os eventos normais.
userIdstring | nullID do usuário definido via setUserId, ou null se anônimo. Preenchido pelo SDK.
sessionIdstring | nullID da sessão atual. Muda no initialize() e a cada troca de userId. Preenchido pelo SDK.
timestampIsostring | nullInstante do evento em ISO-8601 (UTC). É o campo de timestamp que de fato chega preenchido.
timestampMillisnumber | nullExiste por paridade de contrato com os SDKs nativos, mas na prática não é preenchido pelos eventos da WebView — use timestampIso.
questionIdnumber | nullID da pergunta. Presente só em eventos de pergunta.
questionTypestring | nullTipo da pergunta (ver tipos de pergunta). Presente só em eventos de pergunta.
answerstring[] | nullResposta do usuário, sempre como lista de strings. Presente em question_interact / question_answer / survey_answer. Escala/NPS chega como string numérica (ex.: ["9"]); múltipla escolha traz vários itens.
freeTextAnswerstring | nullTexto digitado em campos de texto aberto, quando aplicável.

Trabalhe sempre com os campos opcionais de forma defensiva (?., switch (event.eventType)), lendo apenas o que a tabela de tipos garante para aquele evento.

Tipos de evento​

SurveyEventType — objeto exportado pelo pacote. Cada valor é uma string estável, útil para logar ou encaminhar o tipo ao seu analytics.

ConstanteValor (wireValue)Quando ocorreCampos preenchidos além de eventType / surveyId
SURVEY_IMPRESSIONsurvey_impressionA pesquisa apareceu na tela.sessionId, timestamp
SURVEY_INTERACTsurvey_interactInteração genérica com a pesquisa.timestamp
SURVEY_MINIMIZEsurvey_minimizeUsuário minimizou a pesquisa.timestamp
SURVEY_MAXIMIZEsurvey_maximizeUsuário restaurou a pesquisa minimizada.timestamp
SURVEY_CLOSEsurvey_closePesquisa fechada/dispensada sem envio.timestamp
QUESTION_IMPRESSIONquestion_impressionUma pergunta ficou visível.questionId, questionType
QUESTION_INTERACTquestion_interactUsuário mexeu num controle da pergunta (ainda sem confirmar).questionId, questionType, answer parcial
QUESTION_ANSWERquestion_answerUsuário respondeu uma pergunta.questionId, questionType, answer e/ou freeTextAnswer
QUESTION_SKIPquestion_skipPergunta pulada.questionId, questionType
SURVEY_ANSWERsurvey_answerResposta consolidada da pesquisa.answer
SURVEY_SUBMITsurvey_submitUsuário concluiu e enviou a pesquisa.sessionId, timestamp

Tipos de pergunta​

Valores possíveis de questionType (vêm da mesma WebView usada pelos SDKs Android/iOS):

questionTypeSignificadoConteúdo de answer
radioEscolha única1 item — o texto da opção
selectDropdown de escolha única1 item
checkboxMúltipla escolha1+ itens
npsNota NPS (0–10)1 item — a nota como string (["10"])
rating / scale / star / emojiNota / escala1 item — a nota como string
textTexto livreo texto digitado (em answer e/ou freeTextAnswer)

Exemplo: acompanhar o funil da pesquisa​

import type { SurveyAnalyticsEvent } from '@goab_ltda/survey-sdk-react-native';
import { SurveyEventType } from '@goab_ltda/survey-sdk-react-native';

function criarFunnelTracker(analytics: Analytics) {
return (event: SurveyAnalyticsEvent) => {
const base = { survey_id: event.surveyId, session_id: event.sessionId };
switch (event.eventType) {
case SurveyEventType.SURVEY_IMPRESSION:
analytics.track('survey_impression', base);
break;

case SurveyEventType.QUESTION_ANSWER:
analytics.track('survey_question_answered', {
...base,
question_id: event.questionId,
question_type: event.questionType,
answer: (event.answer as string[] | null)?.join('|'),
});
break;

case SurveyEventType.SURVEY_SUBMIT:
analytics.track('survey_completed', base);
break;

case SurveyEventType.SURVEY_CLOSE:
analytics.track('survey_abandoned', base);
break;

default:
break;
}
};
}

const funnelTracker = criarFunnelTracker(analytics);
surveySdk.addOnSurveyEventListener(funnelTracker);

Próximos passos​