api-referencePOST
POSThttps://analytics.flowsery.com/analytics/api/v1/goals

Grave um evento de meta personalizado. Apenas o nome é obrigatório; VisitorUid, sessionUid, metadados e fuso horário são opcionais.

Token Bearer (token de workspace ou chave API de website)

Os tokens do espaço de trabalho precisam de um seletor de site

Os tokens da API do Workspace podem acessar todos os sites do workspace. Passe <code>websiteId</code> ou <code>domain</code> para que Flowsery saiba qual site consultar ou alterar. As chaves da API do site já têm como escopo um site, portanto o seletor pode ser omitido.

Seletor de site

ParametroTipoDescricao
websiteIdstringID do site a ser usado com um token de API do workspace. Inclua este campo no corpo JSON, a menos que você forneça domain. Omitir ao autenticar com uma chave de API de site.
domainstringSite domain para usar com um token de API do espaço de trabalho quando websiteId não for fornecido. Inclua este campo no corpo JSON. Omitir ao autenticar com uma chave de API de site.

Corpo da requisicao

ParametroTipoDescricao
visitorUidstringID de visitante Flowsery opcional, normalmente proveniente do cookie _fs_vid no seu próprio back-end.
sessionUidstringID de sessão Flowsery opcional, normalmente proveniente do cookie _fs_sid.
nameOBRIGATORIOstringNome do objetivo (letras minusculas, numeros, sublinhados e hifens; max 64 caracteres).
metadataobjectPares chave-valor opcionais, em strings, salvos com a conversão. Até 10 pares.

Regras do campo metadata

<strong>Chaves:</strong> nomes curtos em minúsculas como <code>plan</code> ou <code>signup_source</code> deixam os relatórios legíveis. A API não verifica o formato das chaves.

<strong>Valores:</strong> strings, salvas como enviadas. Não coloque dados pessoais como e-mails nos metadados.

<strong>Limite:</strong> até 10 pares por evento. Mais de 10 retorna <code>400 Bad Request</code>.

Nenhuma visualização de página existente é necessária

A meta é criada no primeiro uso e uma conversão não precisa de uma visualização de página anterior. Sem visitorUid, a conversão é registrada como anônima. Cada chamada adiciona uma conversão, então repeti-la conta a meta duas vezes.

Respostas de erro

<strong>400 Bad Request</strong> -- A carga é inválida, por exemplo um nome com maiúsculas ou espaços, ou mais de 10 pares de metadados.

<strong>404 Not Found</strong> -- O websiteId ou o domain não corresponde a nenhum site que esta credencial alcance.

Exemplo de requisicao (Node.js)
const handler = async (req, res) => {
  const _fs_vid = req.cookies._fs_vid;
  const _fs_sid = req.cookies._fs_sid;

  const response = await fetch(
    "https://analytics.flowsery.com/analytics/api/v1/goals",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${FLOWSERY_API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        websiteId: process.env.FLOWSERY_WEBSITE_ID,
        visitorUid: _fs_vid,
        sessionUid: _fs_sid,
        name: "newsletter_signup",
        metadata: {
          plan: "pro",
          form: "footer",
        },
      }),
    }
  );

  const result = await response.json();
  res.status(200).send("Goal tracked");
};
200
{
  "status": "success",
  "data": [{
    "message": "Custom event created successfully"
  }]
}