api-referenceGET
GEThttps://analytics.flowsery.com/analytics/api/v1/metadata

Haal de configuratiemetadata van je website op.

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. 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. Laat weg als je authenticeert met een website-API-sleutel.

Velden in het antwoord

Velden in het antwoord

ParameterTypeBeschrijving
domainstringHet domein van de website.
timezonestringIANA-tijdzone-ID van de site (bijv. "America/New_York", "UTC").
logostring | nullURL van het eigen sitelogo, of null als er geen is ingesteld.
kpiColorSchemestringKleurenschema voor KPI-visualisaties. Mogelijke waarden: red, orange, yellow, green, purple, pink, gray, blue, teal, indigo.
kpistring | nullDe naam van het aangepaste goal/event dat als belangrijkste prestatie-indicator van deze site is ingesteld.
currencystringValutacode (bijv. "USD", "EUR", "GBP").
Voorbeeldverzoek (curl)
curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/metadata \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "domain": "example.com",
      "timezone": "America/New_York",
      "logo": "https://d1aebdcemlt4l7.cloudfront.net/website-logos/xK9mPq2bR7nYwJ3vL5tA.png",
      "kpiColorScheme": "orange",
      "kpi": "signup",
      "currency": "USD"
    }
  ]
}