api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/citiesRecupere dados analíticos segmentados por cidade.
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. PassewebsiteId 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 da cidade em value, o countryCode do seu país, a contagem de visitantes, a receita dividida em newRevenue e renewalRevenue, e sua parcela de visitantes em percentage.
Combinar filtros
Separe vários valores dentro de um mesmo parâmetro de filtro com |. Combine diferentes parâmetros de filtro para refinar os resultados (ex.:filter_country=United States&filter_city=New York|Boston).Exemplo de requisição (curl)
curl --request GET \
--url 'https://analytics.flowsery.com/analytics/api/v1/cities?limit=10' \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"value": "Singapore",
"countryCode": "SG",
"visitors": 350,
"revenue": 0,
"newRevenue": 0,
"renewalRevenue": 0,
"percentage": 27.3
},
{
"value": "Paris",
"countryCode": "FR",
"visitors": 280,
"revenue": 890,
"newRevenue": 770,
"renewalRevenue": 120,
"percentage": 21.9
},
{
"value": "Jakarta",
"countryCode": "ID",
"visitors": 240,
"revenue": 0,
"newRevenue": 0,
"renewalRevenue": 0,
"percentage": 18.8
},
{
"value": "Toronto",
"countryCode": "CA",
"visitors": 210,
"revenue": 650,
"newRevenue": 560,
"renewalRevenue": 90,
"percentage": 16.4
},
{
"value": "Warsaw",
"countryCode": "PL",
"visitors": 200,
"revenue": 0,
"newRevenue": 0,
"renewalRevenue": 0,
"percentage": 15.6
}
],
"pagination": {
"limit": 100,
"offset": 0,
"total": 2297
}
}