https://analytics.flowsery.com/analytics/api/v1/goalsRejestruje zdarzenie własnego celu. Wymagane jest tylko name; visitorUid, sessionUid, metadata i timezone są opcjonalne.
Tokeny obszaru roboczego wymagają wskazania witryny
Tokeny API obszaru roboczego mają dostęp do wszystkich witryn w obszarze. Należy przekazaćwebsiteId lub domain, aby Flowsery wiedziało, której witryny dotyczy zapytanie lub zmiana. Klucze API witryn są już przypisane do jednej witryny, więc można to pominąć.Wskazanie witryny
| Parametr | Typ | Opis |
|---|---|---|
websiteId | string | ID witryny używane z tokenem API obszaru roboczego. Pole należy umieścić w treści JSON, chyba że podano domain. Należy pominąć przy uwierzytelnianiu kluczem API witryny. |
domain | string | Domena witryny używana z tokenem API obszaru roboczego, gdy nie podano websiteId. Pole należy umieścić w treści JSON. Należy pominąć przy uwierzytelnianiu kluczem API witryny. |
Treść żądania
| Parametr | Typ | Opis |
|---|---|---|
visitorUid | string | Opcjonalny identyfikator odwiedzającego Flowsery, zwykle z cookie _fs_vid odczytanego na własnym backendzie. |
sessionUid | string | Opcjonalny identyfikator sesji Flowsery, zwykle z cookie _fs_sid. |
nameWYMAGANE | string | Nazwa celu (małe litery, cyfry, podkreślenia i myślniki; maksymalnie 64 znaki). |
metadata | object | Opcjonalne pary klucz-wartość (ciągi znaków) zapisywane z realizacją. Maksymalnie 10 par. |
Zasady pól metadanych
<strong>Klucze:</strong> krótkie nazwy małymi literami, np. plan lub signup_source, zachowują czytelność raportów. API nie sprawdza formatu kluczy.
<strong>Wartości:</strong> ciągi znaków zapisywane bez zmian. W metadanych nie należy umieszczać danych osobowych, np. adresów e-mail.
<strong>Limit:</strong> maksymalnie 10 par na zdarzenie. Większa liczba zwraca 400 Bad Request.
Wcześniejsza odsłona nie jest wymagana
Cel powstaje przy pierwszym użyciu, a realizacja nie wymaga wcześniejszej odsłony. Bez visitorUid realizacja jest zapisywana jako anonimowa. Każde wywołanie dodaje jedną realizację, więc jego powtórzenie policzy cel dwukrotnie.Odpowiedzi z błędami
<strong>400 Bad Request</strong> -- Treść jest nieprawidłowa, np. nazwa z wielkimi literami lub spacjami albo ponad 10 par metadanych.
<strong>404 Not Found</strong> -- websiteId lub domain nie odpowiada witrynie dostępnej dla tych danych uwierzytelniających.
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"
}]
}