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

Pobiera metadane konfiguracji witryny.

Bearer Token (token obszaru roboczego lub klucz API witryny)

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

ParametrTypOpis
websiteIdstringID witryny używane z tokenem API obszaru roboczego. Należy pominąć przy uwierzytelnianiu kluczem API witryny.
domainstringDomena witryny używana z tokenem API obszaru roboczego, gdy nie podano websiteId. Należy pominąć przy uwierzytelnianiu kluczem API witryny.

Pola odpowiedzi

Pola odpowiedzi

ParametrTypOpis
domainstringDomena witryny.
timezonestringIdentyfikator strefy czasowej IANA witryny (np. "America/New_York", "UTC").
logostring | nullAdres URL własnego logo witryny lub null, jeśli nie ustawiono.
kpiColorSchemestringSchemat kolorów wizualizacji KPI. Możliwe wartości: red, orange, yellow, green, purple, pink, gray, blue, teal, indigo.
kpistring | nullNazwa własnego celu lub zdarzenia wskazanego jako kluczowy wskaźnik efektywności tej witryny.
currencystringKod waluty (np. "USD", "EUR", "GBP").
Przykładowe żądanie (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"
    }
  ]
}