Referência da API

Criar objetivo

Name: Flowsery
Author: Flowsery

Registrar um evento de objetivo personalizado para um visitante

POSThttps://analytics.flowsery.com/goals

Registre um evento de objetivo personalizado para um visitante especifico.

Chave API (Bearer token)

Corpo da requisicao

Parametro	Tipo	Descricao
`visitorUid`	`string`	O identificador de visitante do Flowsery Analytics. Este valor e armazenado no cookie do navegador _fs_vid, tornando-o acessivel a partir dos seus endpoints do lado do servidor.
`name`OBRIGATORIO	`string`	Nome do objetivo (letras minusculas, numeros, sublinhados e hifens; max 64 caracteres).
`metadata`	`object`	Pares chave-valor personalizados para enriquecer o evento. Ate 10 parametros por evento.

Regras do campo metadata

Chaves: Apenas letras minusculas, numeros, sublinhados (_) e hifens (-). Max 64 caracteres.

Valores: Qualquer string ate 255 caracteres. Conteudo HTML e script e automaticamente removido por seguranca.

Limite: Ate 10 parametros personalizados por evento.

O visitante deve ter uma visualizacao de pagina

O visitante deve ter pelo menos uma visualizacao de pagina registrada antes de um objetivo poder ser criado. Um erro 404 e retornado quando nenhuma visualizacao de pagina existe para o visitante.

Respostas de erro

400 Bad Request -- Retornado quando o visitante e identificado como um bot.

404 Not Found -- Retornado quando nenhuma visualizacao de pagina existe para o visitante especificado.

Exemplo de requisicao (Node.js)

const handler = async (req, res) => {
  const _fs_vid = req.cookies._fs_vid;

  const response = await fetch(
    "https://analytics.flowsery.com/api/v1/goals",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${FLOWSERY_API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        visitorUid: _fs_vid,
        name: "newsletter_signup",
        metadata: {
          name: "Elon Musk",
          email: "musk@x.com",
        },
      }),
    }
  );

  const result = await response.json();
  res.status(200).send("Goal tracked");
};

200

{
  "status": "success",
  "data": [{
    "message": "Custom event created successfully",
    "eventId": "67f8b9b5c320277df9a9d681"
  }]
}