Referencia API

Crear objetivo

Name: Flowsery
Author: Flowsery

Registrar un evento de objetivo personalizado para un visitante

POSThttps://analytics.flowsery.com/goals

Registrar un evento de objetivo personalizado para un visitante especifico.

Clave API (Bearer token)

Cuerpo de solicitud

Parametro	Tipo	Descripcion
`visitorUid`	`string`	El ID de visitante de Flowsery Analytics. Este valor se almacena en la cookie del navegador _fs_vid, lo que lo hace accesible desde sus endpoints del lado del servidor.
`name`OBLIGATORIO	`string`	Nombre del objetivo (letras minusculas, numeros, guiones bajos y guiones; max. 64 caracteres).
`metadata`	`object`	Pares clave-valor personalizados para enriquecer el evento. Hasta 10 parametros por evento.

Reglas del campo metadata

Claves: Solo letras minusculas, numeros, guiones bajos (_) y guiones (-). Max. 64 caracteres.

Valores: Cualquier cadena de texto hasta 255 caracteres. El contenido HTML y de scripts se elimina automaticamente por seguridad.

Limite: Hasta 10 parametros personalizados por evento.

El visitante debe tener una vista de pagina

El visitante debe tener al menos una vista de pagina registrada antes de que se pueda crear un objetivo. Se devuelve un 404 cuando no existe ninguna vista de pagina para el visitante.

Respuestas de error

400 Bad Request -- Se devuelve cuando el visitante es identificado como un bot.

404 Not Found -- Se devuelve cuando no existe ninguna vista de pagina para el visitante indicado.

Solicitud de ejemplo (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"
  }]
}