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

Recupere métricas analiticas agregadas para o 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.

Parâmetros de consulta

ParâmetroTipoDescrição
startAtstringData/hora de início da ISO 8601. A norma são os últimos 30 dias quando omitido.
endAtstringData/hora de término da ISO 8601. O padrão é agora quando omitido.
timezonestringIdentificador de fuso horário IANA. Recorre ao fuso horário configurado do site.

Parâmetros de filtro

ParâmetroTipoDescrição
filter_countrystringNome do país como retornado por /countries, ex.: United States. Use | para vários valores, ! para excluir e ~ para uma correspondência parcial.
filter_regionstringNome da região ou do estado como retornado por /regions, ex.: Califórnia.
filter_citystringNome da cidade.
filter_devicestringTipo de dispositivo: Desktop, Mobile ou Tablet. Os valores diferenciam maiúsculas de minúsculas.
filter_browserstringNome do navegador (Chrome, Safari, Firefox, Edge). Safari inclui automaticamente Mobile Safari.
filter_osstringSistema operacional (Mac OS, Windows, iOS, Android).
filter_referrerstringReferência como retornada por /referrers: um nome de fonte como Google para sites reconhecidos, caso contrário o domínio.
filter_refstringValor do parâmetro URL ref.
filter_sourcestringValor do parâmetro URL source.
filter_viastringValor do parâmetro URL via.
filter_utm_sourcestringFonte UTM.
filter_utm_mediumstringMeio UTM.
filter_utm_campaignstringCampanha UTM.
filter_utm_termstringTermo UTM.
filter_utm_contentstringConteúdo UTM.
filter_pagestringCaminho ou URL da página.
filter_entry_pagestringCaminho ou URL da página de entrada.
filter_hostnamestringHostname/domínio.
filter_channelstringCanal de marketing.
filter_goalstringNome do objetivo.

Notas

Sem um intervalo de datas, a API usa os últimos 30 dias até agora. bounceRate e conversionRate são percentuais; avgSessionDuration e avgEngagedTime estão em segundos. Os valores de filtro aceitam | para vários valores, ! para excluir e ~ para uma correspondência parcial.
Exemplo de requisição (curl)
curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/overview \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890,
      "bounceRate": 65.32,
      "avgSessionDuration": 246,
      "avgEngagedTime": 187,
      "revenue": 28450,
      "renewalRevenue": 6320,
      "refundedRevenue": 410,
      "revenuePerVisitor": 2.29,
      "conversionRate": 1.15,
      "kpiValue": 28450,
      "kpiPerVisitor": 2.29,
      "kpiConversionRate": 1.15,
      "currency": "USD"
    }
  ]
}