https://analytics.flowsery.com/analytics/api/v1/goalsZeichnen Sie ein benutzerdefiniertes Zielereignis auf. Es ist nur der Name erforderlich; Besucher-ID, Sitzungs-ID, Metadaten und Zeitzone sind optional.
Workspace-Tokens benötigen einen Website-Selektor
Workspace-API-Tokens können auf jede Website im Workspace zugreifen. Übergeben Sie entweder <code>websiteId</code> oder <code>domain</code>, damit Flowsery weiß, welche Website abgefragt oder geändert werden muss. Website-API-Schlüssel sind bereits auf eine Website beschränkt, sodass der Selektor weggelassen werden kann.Website-Auswahl
| Parameter | Typ | Beschreibung |
|---|---|---|
websiteId | string | Website-ID zur Verwendung mit einem Workspace-API-Token. Fügen Sie dieses Feld in den JSON-Text ein, es sei denn, Sie geben domain an. Bei der Authentifizierung mit einem Website-API-Schlüssel weglassen. |
domain | string | Website domain zur Verwendung mit einem Workspace-API-Token, wenn websiteId nicht bereitgestellt wird. Fügen Sie dieses Feld in den JSON-Text ein. Bei der Authentifizierung mit einem Website-API-Schlüssel weglassen. |
Anfrage-Body
| Parameter | Typ | Beschreibung |
|---|---|---|
visitorUid | string | Optionale Flowsery Besucher-ID, die normalerweise aus dem _fs_vid-Cookie in Ihrem eigenen Backend stammt. |
sessionUid | string | Optionale Flowsery-Sitzungs-ID, die normalerweise aus dem _fs_sid-Cookie stammt. |
nameERFORDERLICH | string | Zielname (Kleinbuchstaben, Zahlen, Unterstriche und Bindestriche; max. 64 Zeichen). |
metadata | object | Optionale Schlüssel-Wert-Paare als Strings, die mit dem Abschluss gespeichert werden. Höchstens 10 Paare. |
Regeln fuer das Metadaten-Feld
<strong>Schlüssel:</strong> Kurze Namen in Kleinbuchstaben wie <code>plan</code> oder <code>signup_source</code> halten Berichte lesbar. Die API prüft das Schlüsselformat nicht.
<strong>Werte:</strong> Strings, die unverändert gespeichert werden. Legen Sie keine personenbezogenen Daten wie E-Mail-Adressen in Metadaten ab.
<strong>Limit:</strong> Höchstens 10 Paare pro Ereignis. Mehr als 10 ergeben <code>400 Bad Request</code>.
Kein bestehender Seitenaufruf erforderlich
Das Ziel wird bei der ersten Verwendung angelegt, und ein Abschluss braucht keinen vorherigen Seitenaufruf. Ohne visitorUid wird der Abschluss anonym erfasst. Jeder Aufruf fügt einen Abschluss hinzu, eine Wiederholung zählt das Ziel also doppelt.Fehlerantworten
<strong>400 Bad Request</strong> -- Die Nutzlast ist ungültig, etwa ein Name mit Großbuchstaben oder Leerzeichen oder mehr als 10 Metadaten-Paare.
<strong>404 Not Found</strong> -- websiteId oder domain passt zu keiner Website, die diese Zugangsdaten erreichen.
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");
};{
"status": "success",
"data": [{
"message": "Custom event created successfully"
}]
}