API-Referenz

Ziel erstellen

Name: Flowsery
Author: Flowsery

Ein benutzerdefiniertes Ziel-Event für einen Besucher erfassen

POSThttps://analytics.flowsery.com/goals

Ein benutzerdefiniertes Zielereignis fuer einen bestimmten Besucher aufzeichnen.

API-Schluessel (Bearer-Token)

Anfrage-Body

Parameter	Typ	Beschreibung
`visitorUid`	`string`	Die Flowsery Analytics Besucher-ID. Dieser Wert wird im _fs_vid-Browser-Cookie gespeichert und ist somit von Ihren serverseitigen Endpunkten aus zugaenglich.
`name`ERFORDERLICH	`string`	Zielname (Kleinbuchstaben, Zahlen, Unterstriche und Bindestriche; max. 64 Zeichen).
`metadata`	`object`	Benutzerdefinierte Schluessel-Wert-Paare zur Anreicherung des Ereignisses. Bis zu 10 Parameter pro Ereignis.

Regeln fuer das Metadaten-Feld

Schluessel: Nur Kleinbuchstaben, Zahlen, Unterstriche (_) und Bindestriche (-). Max. 64 Zeichen.

Werte: Beliebige Zeichenkette bis zu 255 Zeichen. HTML- und Skriptinhalte werden aus Sicherheitsgruenden automatisch entfernt.

Limit: Bis zu 10 benutzerdefinierte Parameter pro Ereignis.

Besucher muss einen Seitenaufruf haben

Der Besucher muss mindestens einen aufgezeichneten Seitenaufruf haben, bevor ein Ziel erstellt werden kann. Ein 404-Fehler wird zurueckgegeben, wenn kein Seitenaufruf fuer den Besucher existiert.

Fehlerantworten

400 Bad Request -- Wird zurueckgegeben, wenn der Besucher als Bot identifiziert wurde.

404 Not Found -- Wird zurueckgegeben, wenn kein Seitenaufruf fuer den angegebenen Besucher existiert.

Beispielanfrage (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"
  }]
}