Referência da API

Objetivos

Name: Flowsery
Author: Flowsery

Obter detalhamento de análise de objetivos

GEThttps://analytics.flowsery.com/goals

Recupere dados analiticos segmentados por objetivos personalizados.

Chave API (Bearer token)

Parametros opcionais

Parametro	Tipo	Descricao
`startAt`	`string`	Data/hora de inicio ISO 8601. Omita para dados de todo o periodo.
`endAt`	`string`	Data/hora de fim ISO 8601. Deve acompanhar startAt.
`timezone`	`string`	Fuso horario para agregacao (por ex., UTC, America/New_York). Recorre ao fuso horario configurado do seu site.
`limit`	`number`	Numero maximo de linhas a retornar (1-1000, padrao: 100).
`offset`	`number`	Linhas a pular para paginacao (min 0, padrao: 0).

Parametros de filtro

Parametro	Tipo	Descricao
`filter_country`	`string`	Nome ou codigo do pais (por ex., filter_country=United States,Canada).
`filter_region`	`string`	Regiao ou estado.
`filter_city`	`string`	Nome da cidade.
`filter_device`	`string`	Tipo de dispositivo -- desktop, mobile, tablet.
`filter_browser`	`string`	Nome do navegador. Safari inclui automaticamente Mobile Safari.
`filter_os`	`string`	Sistema operacional.
`filter_referrer`	`string`	Dominio de referencia ou nome conhecido.
`filter_ref`	`string`	Parametro URL ref.
`filter_source`	`string`	Parametro URL source.
`filter_via`	`string`	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 da pagina.
`filter_entry_page`	`string`	Caminho da pagina de entrada.
`filter_hostname`	`string`	Hostname/dominio.
`filter_channel`	`string`	Canal de marketing.
`filter_goal`	`string`	Nome do objetivo.

Exemplo de requisicao (curl)

curl --request GET \
  --url https://analytics.flowsery.com/api/v1/goals \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "goal": "faq_what_do_i_get",
      "completions": 49730,
      "visitors": 27797
    },
    {
      "goal": "scroll_to_problem",
      "completions": 35100,
      "visitors": 30807
    },
    {
      "goal": "faq_who_is_this_for",
      "completions": 32731,
      "visitors": 19905
    },
    {
      "goal": "faq_tech_stack",
      "completions": 29262,
      "visitors": 18708
    },
    {
      "goal": "faq_refund_policy",
      "completions": 27843,
      "visitors": 16861
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 48
  }
}