Obter análises por região

api-referenceGET

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

Recupere dados analiticos segmentados por regiao.

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

Parametros de filtro

Parametro	Tipo	Descricao
`filter_country`	`string`	Nome ou indicativo do país. Usar \| para vários valores e! para excluir.
`filter_region`	`string`	Regiao ou estado.
`filter_city`	`string`	Nome da cidade.
`filter_device`	`string`	Tipo de dispositivo. Utilize valores de back-end como Desktop\|Mobile\|Tablet e! para excluir.
`filter_browser`	`string`	Nome do navegador. Safari inclui automaticamente Mobile Safari.
`filter_os`	`string`	Sistema operacional (Mac OS, Windows, iOS, Android).
`filter_referrer`	`string`	Dominio de referencia ou nome conhecido.
`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 no array <code>data</code> contem o nome da regiao, a contagem de visitantes e a receita atribuida a essa regiao.

Combinar filtros

Passe valores separados por virgula em um unico parametro de filtro para corresponder a multiplos itens. Combine diferentes parametros de filtro para refinar os resultados (por ex., <code>filter_country=United States&filter_region=California</code>).

Exemplo de requisicao (curl)

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

200

{
  "status": "success",
  "data": [
    {
      "value": "California",
      "visitors": 1150,
      "revenue": 3420,
      "renewalRevenue": 780,
      "percentage": 33.8
    },
    {
      "value": "Ile-de-France",
      "visitors": 720,
      "revenue": 1890,
      "renewalRevenue": 420,
      "percentage": 21.2
    },
    {
      "value": "England",
      "visitors": 540,
      "revenue": 1450,
      "renewalRevenue": 260,
      "percentage": 15.9
    },
    {
      "value": "Berlin",
      "visitors": 480,
      "revenue": 1230,
      "renewalRevenue": 200,
      "percentage": 14.1
    },
    {
      "value": "Madrid",
      "visitors": 510,
      "revenue": 980,
      "renewalRevenue": 120,
      "percentage": 15
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 656
  }
}