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

Recupere metricas analiticas agregadas para o seu site.

Chave API (Bearer token)

Parametros de consulta

ParametroTipoDescricao
startAtstringData/hora de início da ISO 8601. A norma são os últimos 30 dias quando omitido.
endAtstringISO 8601 end date/time. Defaults to now when omitted.
timezonestringIdentificador de fuso horario IANA. Recorre ao fuso horario configurado do site.

Parametros de filtro

ParametroTipoDescricao
filter_countrystringNome ou codigo do pais (por ex., filter_country=United States,Canada).
filter_regionstringRegiao ou estado.
filter_citystringNome da cidade.
filter_devicestringTipo de dispositivo (desktop, mobile, tablet).
filter_browserstringNome do navegador (Chrome, Safari, Firefox, Edge). Safari inclui automaticamente Mobile Safari.
filter_osstringSistema operacional (Mac OS, Windows, iOS, Android).
filter_referrerstringDominio de referencia ou nome de referencia conhecido.
filter_refstringValor do parametro URL ref.
filter_sourcestringValor do parametro URL source.
filter_viastringValor do parametro URL via.
filter_utm_sourcestringFonte UTM.
filter_utm_mediumstringMeio UTM.
filter_utm_campaignstringCampanha UTM.
filter_utm_termstringTermo UTM.
filter_utm_contentstringConteudo UTM.
filter_pagestringCaminho ou URL da pagina.
filter_entry_pagestringCaminho ou URL da pagina de entrada.
filter_hostnamestringHostname/dominio.
filter_channelstringCanal de marketing.
filter_goalstringNome do objetivo.

Notas

Quando não é fornecido nenhum intervalo de datas, o padrão API é os últimos 30 dias até ao momento. A taxa de conversão é expressa em percentagem. Suporte de valores de filtro | para correspondência de vários valores e! para negação.
Exemplo de requisicao (curl)
curl --request GET \
  --url https://analytics.flowsery.com/api/v1/overview \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890,
      "bounceRate": 65.32,
      "avgSessionDuration": 245678.45,
      "avgEngagedTime": 187432.12,
      "revenue": 28450,
      "renewalRevenue": 6320,
      "refundedRevenue": 410,
      "revenuePerVisitor": 2.29,
      "conversionRate": 1.15,
      "kpiValue": 28450,
      "kpiPerVisitor": 2.29,
      "kpiConversionRate": 1.15,
      "currency": "USD"
    }
  ]
}