api-referencePOST
POSThttps://analytics.flowsery.com/analytics/api/v1/goals

Registreer een aangepast goal-event. Alleen name is verplicht; visitorUid, sessionUid, metadata en timezone zijn optioneel.

Bearer-token (werkruimtetoken of website-API-sleutel)

Werkruimtetokens hebben een websiteselector nodig

Werkruimte-API-tokens hebben toegang tot elke website in de werkruimte. Geef websiteId of domain mee, zodat Flowsery weet welke website je wilt opvragen of wijzigen. Website-API-sleutels horen al bij één website, dus daar kun je de selector weglaten.

Websiteselector

ParameterTypeBeschrijving
websiteIdstringWebsite-ID om te gebruiken met een werkruimte-API-token. Neem dit veld op in de JSON-body, tenzij je domain meegeeft. Laat weg als je authenticeert met een website-API-sleutel.
domainstringWebsitedomein om te gebruiken met een werkruimte-API-token als er geen websiteId is opgegeven. Neem dit veld op in de JSON-body. Laat weg als je authenticeert met een website-API-sleutel.

Request-body

ParameterTypeBeschrijving
visitorUidstringOptionele Flowsery-bezoekers-ID, meestal afkomstig uit de cookie _fs_vid in je eigen backend.
sessionUidstringOptionele Flowsery-sessie-ID, meestal afkomstig uit de cookie _fs_sid.
nameVERPLICHTstringGoalnaam (kleine letters, cijfers, underscores en koppeltekens; maximaal 64 tekens).
metadataobjectOptionele sleutel-waardeparen (strings) die met de voltooiing worden opgeslagen. Maximaal 10 paren.

Regels voor metadatavelden

<strong>Sleutels:</strong> korte namen in kleine letters, zoals plan of signup_source, houden rapporten leesbaar. De API controleert het formaat van sleutels niet.

<strong>Waarden:</strong> strings, opgeslagen zoals verstuurd. Zet geen persoonsgegevens zoals e-mailadressen in metadata.

<strong>Limiet:</strong> maximaal 10 paren per event. Bij meer dan 10 volgt 400 Bad Request.

Geen bestaande paginaweergave nodig

De goal wordt bij het eerste gebruik aangemaakt, en een voltooiing heeft geen eerdere paginaweergave nodig. Zonder visitorUid wordt de voltooiing anoniem geregistreerd. Elke aanroep voegt één voltooiing toe, dus als je hem herhaalt, telt de goal dubbel.

Foutantwoorden

<strong>400 Bad Request</strong> -- De payload is ongeldig, bijvoorbeeld een naam met hoofdletters of spaties, of meer dan 10 metadataparen.

<strong>404 Not Found</strong> -- De websiteId of het domain komt niet overeen met een website waar deze sleutel bij kan.

Voorbeeldverzoek (Node.js)
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");
};
200
{
  "status": "success",
  "data": [{
    "message": "Custom event created successfully"
  }]
}