Référence API

Créer un objectif

Name: Flowsery
Author: Flowsery

Enregistrer un événement d'objectif personnalisé pour un visiteur

POSThttps://analytics.flowsery.com/goals

Enregistrez un evenement d'objectif personnalise pour un visiteur donne.

Cle API (Bearer token)

Corps de la requete

Parametre	Type	Description
`visitorUid`	`string`	L'identifiant de visiteur Flowsery Analytics. Cette valeur est stockee dans le cookie de navigateur _fs_vid, la rendant accessible depuis vos points de terminaison cote serveur.
`name`REQUIS	`string`	Nom de l'objectif (lettres minuscules, chiffres, tirets bas et tirets ; max 64 caracteres).
`metadata`	`object`	Paires cle-valeur personnalisees pour enrichir l'evenement. Jusqu'a 10 parametres par evenement.

Regles du champ metadata

Cles : Uniquement des lettres minuscules, des chiffres, des tirets bas (_) et des tirets (-). Max 64 caracteres.

Valeurs : N'importe quelle chaine jusqu'a 255 caracteres. Le contenu HTML et script est automatiquement supprime pour la securite.

Limite : Jusqu'a 10 parametres personnalises par evenement.

Le visiteur doit avoir une page vue

Le visiteur doit avoir au moins une page vue enregistree avant de pouvoir creer un objectif. Une erreur 404 est retournee lorsqu'aucune page vue n'existe pour le visiteur.

Reponses d'erreur

400 Bad Request -- Retourne lorsque le visiteur est identifie comme un bot.

404 Not Found -- Retourne lorsqu'aucune page vue n'existe pour le visiteur donne.

Exemple de requete (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"
  }]
}