Obter um detalhamento por qualquer dimensão

api-referenceGET

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

Agrupar visitantes por qualquer uma das 25 dimensões, inclusive as que não têm endpoint próprio, como entry_page, exit_link, browser_version, os_version, via e cada parâmetro UTM.

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
`dimension`OBRIGATORIO	`string`	O atributo pelo qual agrupar os visitantes: um dos 25 valores listados em Dimensões. Qualquer outro valor retorna 400.
`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 horario para agregacao (por ex., UTC, America/New_York). Recorre ao fuso horario configurado do site.
`limit`	`number`	Numero maximo de linhas a retornar (1-1000, padrao: 100).
`offset`	`number`	Linhas a pular para paginacao (min 0, padrao: 0).

Dimensões

Parametro	Tipo	Descricao
`device`	`string`	Tipo de dispositivo: Desktop, Mobile ou Tablet.
`page`	`string`	Caminho da página.
`entry_page`	`string`	Primeira página da sessão.
`exit_link`	`string`	Link externo que o visitante clicou para sair do site. A receita é sempre 0.
`hostname`	`string`	Hostname que serviu a página.
`referrer`	`string`	Nome da fonte de referência, como Google, ou o domínio para sites que o Flowsery não reconhece. As linhas incluem iconUrl.
`channel`	`string`	Canal de aquisição, as mesmas linhas de GET /channels.
`campaign`	`string`	Campanha UTM, as mesmas linhas de GET /campaigns.
`goal`	`string`	Nome da meta. visitors traz o número de conclusões e a receita é sempre 0.
`country`	`string`	Nome do país. As linhas incluem countryCode.
`region`	`string`	Região ou estado pelo nome completo, como California. As linhas incluem countryCode.
`city`	`string`	Nome da cidade. As linhas incluem countryCode.
`browser`	`string`	Nome do navegador.
`browser_version`	`string`	Versão do navegador.
`os`	`string`	Sistema operacional.
`os_version`	`string`	Versão do sistema operacional.
`utm_source`	`string`	O parâmetro de URL utm_source.
`utm_medium`	`string`	O parâmetro de URL utm_medium.
`utm_campaign`	`string`	O parâmetro de URL utm_campaign.
`utm_term`	`string`	O parâmetro de URL utm_term.
`utm_content`	`string`	O parâmetro de URL utm_content.
`ref`	`string`	O parâmetro de URL ref.
`source`	`string`	O parâmetro de URL source.
`via`	`string`	O parâmetro de URL via, comum em links de afiliados e parceiros.
`all_params`	`string`	Todos os parâmetros de rastreamento da sessão unidos em um só valor, como utm_source=google&utm_medium=cpc.

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. 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.

Campos de resposta

Cada item do array <code>data</code> contém o valor agrupado em <code>value</code>, o número de visitantes, a receita dividida em <code>newRevenue</code> e <code>renewalRevenue</code> e sua parcela dos visitantes em <code>percentage</code>. Dimensões geográficas acrescentam <code>countryCode</code> e <code>referrer</code> acrescenta <code>iconUrl</code>. Um valor não capturado volta como <code>Unknown</code>.

Os valores batem com os filtros

Os valores voltam no formato que os parâmetros <code>filter_*</code> esperam, então qualquer linha pode ser enviada de volta como filtro. Regiões são nomes completos (<code>California</code>, não <code>CA</code>), dispositivos começam com maiúscula (<code>Desktop</code>, <code>Mobile</code>, <code>Tablet</code>) e referências são nomes de fonte (<code>Google</code>, não <code>google.com</code>).

Combinar filtros

Separe vários valores dentro de um mesmo parâmetro de filtro com |. Combine uma dimensão com filtros para responder perguntas mais específicas (ex.: <code>dimension=via&filter_country=United States&filter_device=Mobile</code>).

Exemplo de requisição (Curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "partner_anna",
      "visitors": 640,
      "revenue": 2310,
      "newRevenue": 1980,
      "renewalRevenue": 330,
      "percentage": 51.2
    },
    {
      "value": "partner_marc",
      "visitors": 410,
      "revenue": 1270,
      "newRevenue": 1270,
      "renewalRevenue": 0,
      "percentage": 32.8
    },
    {
      "value": "podcast",
      "visitors": 200,
      "revenue": 380,
      "newRevenue": 290,
      "renewalRevenue": 90,
      "percentage": 16
    }
  ],
  "pagination": {
    "limit": 3,
    "offset": 0,
    "total": 14
  }
}