Obter visão geral do site

api-referenceGET

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

Recupere metricas 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 <code>websiteId</code> ou <code>domain</code> 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

Parametro	Tipo	Descricao
`websiteId`	`string`	ID do site a ser usado com um token de API do workspace. Omitir ao autenticar com uma chave de API de site.
`domain`	`string`	Site 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.

Parametros de consulta

Parametro	Tipo	Descricao
`startAt`	`string`	Data/hora de início da ISO 8601. A norma são os últimos 30 dias quando omitido.
`endAt`	`string`	Data/hora de término da ISO 8601. O padrão é agora quando omitido.
`timezone`	`string`	Identificador de fuso horario IANA. Recorre ao fuso horario configurado do site.

Parametros de filtro

Parametro	Tipo	Descricao
`filter_country`	`string`	Nome do país como retornado por /countries, ex.: United States. Use \| para vários valores, ! para excluir e ~ para uma correspondência parcial.
`filter_region`	`string`	Nome da região ou do estado como retornado por /regions, ex.: California.
`filter_city`	`string`	Nome da cidade.
`filter_device`	`string`	Tipo de dispositivo: Desktop, Mobile ou Tablet. Os valores diferenciam maiúsculas de minúsculas.
`filter_browser`	`string`	Nome do navegador (Chrome, Safari, Firefox, Edge). Safari inclui automaticamente Mobile Safari.
`filter_os`	`string`	Sistema operacional (Mac OS, Windows, iOS, Android).
`filter_referrer`	`string`	Referência como retornada por /referrers: um nome de fonte como Google para sites reconhecidos, caso contrário o domínio.
`filter_ref`	`string`	Valor do parametro URL ref.
`filter_source`	`string`	Valor do parametro URL source.
`filter_via`	`string`	Valor do parametro URL via.
`filter_utm_source`	`string`	Fonte UTM.
`filter_utm_medium`	`string`	Meio UTM.
`filter_utm_campaign`	`string`	Campanha UTM.
`filter_utm_term`	`string`	Termo UTM.
`filter_utm_content`	`string`	Conteudo UTM.
`filter_page`	`string`	Caminho ou URL da pagina.
`filter_entry_page`	`string`	Caminho ou URL da pagina de entrada.
`filter_hostname`	`string`	Hostname/dominio.
`filter_channel`	`string`	Canal de marketing.
`filter_goal`	`string`	Nome 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 requisicao (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"
    }
  ]
}