api-referenceGET
GET
https://analytics.flowsery.com/api/v1/regionsRecupere dados analiticos segmentados por regiao.
Bearer Token (chave API)
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 | ISO 8601 end date/time. Defaults to now when omitted. |
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/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
}
}