Obter análises por canal

api-referenceGET

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

Buscar dados de analytics segmentados por canal de aquisição.

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âmetro	Tipo	Descrição
`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.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`startAt`	`string`	Data/hora de início ISO 8601 (por exemplo, 2024-01-01T00:00:00Z). O predefinido é os últimos 30 dias quando omitido.
`endAt`	`string`	Data/hora de término da ISO 8601. O padrão é agora quando omitido.
`timezone`	`string`	Fuso horário para agregacao (por ex., UTC, America/New_York). Recorre ao fuso horário configurado do site.
`limit`	`number`	Número máximo de linhas a retornar (1-1000, padrão: 100).
`offset`	`number`	Linhas a pular para paginação (min 0, padrão: 0).

Parâmetros de filtro

Parâmetro	Tipo	Descrição
`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.: Califórnia.
`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. 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 parâmetro URL ref.
`filter_source`	`string`	Valor do parâmetro URL source.
`filter_via`	`string`	Valor do parâmetro 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`	Conteúdo UTM.
`filter_page`	`string`	Caminho ou URL da página.
`filter_entry_page`	`string`	Caminho ou URL da página de entrada.
`filter_hostname`	`string`	Hostname/domínio.
`filter_channel`	`string`	Canal de marketing.
`filter_goal`	`string`	Nome do objetivo.

Campos de resposta

Cada item do array data contém o nome do canal em value, o número de visitantes, a receita dividida em newRevenue e renewalRevenue e sua parcela dos visitantes em percentage. Os nomes dos canais vêm em inglês: Direct, Organic search, Paid search, Organic social, Paid social, Referral, Email, A.I., Display, Vídeo, Affiliate, SMS e Áudio.

Combinar filtros

Separe vários valores dentro de um mesmo parâmetro de filtro com |. Passe um nome de canal para filter_channel em qualquer outro relatório para limitá-lo a esse canal (ex.: filter_channel=Organic search|Paid search).

Exemplo de requisição (Curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/channels?limit=5' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "Organic search",
      "visitors": 4120,
      "revenue": 8340,
      "newRevenue": 6910,
      "renewalRevenue": 1430,
      "percentage": 38.6
    },
    {
      "value": "Direct",
      "visitors": 2870,
      "revenue": 5120,
      "newRevenue": 4080,
      "renewalRevenue": 1040,
      "percentage": 26.9
    },
    {
      "value": "Organic social",
      "visitors": 1640,
      "revenue": 1980,
      "newRevenue": 1760,
      "renewalRevenue": 220,
      "percentage": 15.4
    },
    {
      "value": "Referral",
      "visitors": 1210,
      "revenue": 2450,
      "newRevenue": 2010,
      "renewalRevenue": 440,
      "percentage": 11.3
    },
    {
      "value": "Email",
      "visitors": 830,
      "revenue": 1760,
      "newRevenue": 1290,
      "renewalRevenue": 470,
      "percentage": 7.8
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 9
  }
}