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

Recupere os metadados de configuração do seu site.

Token Bearer (token de workspace ou chave API de website)

Os tokens do espaço de trabalho precisam de um seletor de site

Os tokens da API do Workspace podem acessar todos os sites do workspace. Passe websiteId ou domain para que Flowsery saiba qual site consultar ou alterar. As chaves da API do site já têm como escopo um site, portanto o seletor pode ser omitido.

Seletor de site

ParâmetroTipoDescrição
websiteIdstringID do site a ser usado com um token de API do workspace. Omitir ao autenticar com uma chave de API de site.
domainstringSite domain para usar com um token de API do espaço de trabalho quando websiteId não for fornecido. Omitir ao autenticar com uma chave de API de site.

Campos de resposta

Campos de resposta

ParâmetroTipoDescrição
domainstringO domínio do site.
timezonestringIdentificador de fuso horário IANA para o site (por ex., "America/New_York", "UTC").
logostring | nullURL do logo personalizado do site, ou null quando nenhum esta definido.
kpiColorSchemestringEsquema de cores usado para visualizações de KPI. Valores possiveis: red, orange, yellow, green, purple, pink, gray, blue, teal, indigo.
kpistring | nullO nome do objetivo/evento personalizado designado como indicador-chave de desempenho para este site.
currencystringCódigo da moeda (por ex., "USD", "EUR", "GBP").
Exemplo de requisição (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"
    }
  ]
}