api-referenceGET
GET
https://analytics.flowsery.com/api/v1/citiesObtener datos de analisis segmentados por ciudad.
Bearer Token (clave API)
Parametros de consulta
| Parametro | Tipo | Descripcion |
|---|---|---|
startAt | string | Fecha/hora de inicio de ISO 8601 (por ejemplo, 2024-01-01T00:00:00Z). El valor predeterminado es los últimos 30 días cuando se omite. |
endAt | string | ISO 8601 end date/time. Defaults to now when omitted. |
timezone | string | Zona horaria para la agregacion (por ejemplo, UTC, America/New_York). Recurre a la zona horaria configurada del sitio. |
limit | number | Maximo de filas a devolver (1-1000, predeterminado: 100). |
offset | number | Filas a omitir para paginacion (min. 0, predeterminado: 0). |
Parametros de filtro
| Parametro | Tipo | Descripcion |
|---|---|---|
filter_country | string | Nombre o código del país. Uso | para múltiples valores y! excluir. |
filter_region | string | Region o estado. |
filter_city | string | Nombre de ciudad. |
filter_device | string | Tipo de dispositivo. Utilice valores de backend como Escritorio|Móvil|Tableta y! excluir. |
filter_browser | string | Nombre del navegador. Safari incluye Mobile Safari automaticamente. |
filter_os | string | Sistema operativo (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Dominio de referencia o nombre conocido. |
filter_ref | string | El valor del parametro de URL ref. |
filter_source | string | El valor del parametro de URL source. |
filter_via | string | El valor del parametro de URL via. |
filter_utm_source | string | Fuente UTM. |
filter_utm_medium | string | Medio UTM. |
filter_utm_campaign | string | Campana UTM. |
filter_utm_term | string | Termino UTM. |
filter_utm_content | string | Contenido UTM. |
filter_page | string | Ruta de pagina o URL. |
filter_entry_page | string | Ruta o URL de pagina de entrada. |
filter_hostname | string | Nombre de host/dominio. |
filter_channel | string | Canal de marketing. |
filter_goal | string | Nombre del objetivo. |
Campos de respuesta
Cada elemento en el array <code>data</code> contiene el nombre de la ciudad, el conteo de visitantes y los ingresos atribuidos a esa ciudad.
Combinar filtros
Pase valores separados por comas dentro de un solo parametro de filtro para coincidir con multiples elementos. Combine diferentes parametros de filtro para acotar aun mas los resultados (por ejemplo, <code>filter_country=United States&filter_city=New York</code>).Solicitud de ejemplo (curl)
curl --request GET \
--url 'https://analytics.flowsery.com/api/v1/cities?limit=10' \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"value": "Singapore",
"visitors": 350,
"revenue": 0,
"renewalRevenue": 0,
"percentage": 27.3
},
{
"value": "Paris",
"visitors": 280,
"revenue": 890,
"renewalRevenue": 120,
"percentage": 21.9
},
{
"value": "Jakarta",
"visitors": 240,
"revenue": 0,
"renewalRevenue": 0,
"percentage": 18.8
},
{
"value": "Toronto",
"visitors": 210,
"revenue": 650,
"renewalRevenue": 90,
"percentage": 16.4
},
{
"value": "Warsaw",
"visitors": 200,
"revenue": 0,
"renewalRevenue": 0,
"percentage": 15.6
}
],
"pagination": {
"limit": 100,
"offset": 0,
"total": 2297
}
}