api-referenceGET
GET
https://analytics.flowsery.com/api/v1/overviewObtener metricas de analisis agregadas para su sitio web.
Clave API (Bearer token)
Parametros de consulta
| Parametro | Tipo | Descripcion |
|---|---|---|
startAt | string | Fecha/hora de inicio ISO 8601. 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 | Identificador de zona horaria IANA. Recurre a la zona horaria configurada del sitio. |
Parametros de filtro
| Parametro | Tipo | Descripcion |
|---|---|---|
filter_country | string | Nombre o codigo de pais (por ejemplo, filter_country=United States,Canada). |
filter_region | string | Region o estado. |
filter_city | string | Nombre de ciudad. |
filter_device | string | Tipo de dispositivo (desktop, mobile, tablet). |
filter_browser | string | Nombre del navegador (Chrome, Safari, Firefox, Edge). Safari incluye Mobile Safari automaticamente. |
filter_os | string | Sistema operativo (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Dominio de referencia o nombre de referente 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. |
Notas
Cuando no se proporciona ningún rango de fechas, el valor predeterminado API es los últimos 30 días hasta ahora. La tasa de conversión se expresa como porcentaje. Soporte de valores de filtro | para coincidencia de valores múltiples y! por la negación.Solicitud de ejemplo (curl)
curl --request GET \
--url https://analytics.flowsery.com/api/v1/overview \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"visitors": 12450,
"sessions": 16890,
"bounceRate": 65.32,
"avgSessionDuration": 245678.45,
"avgEngagedTime": 187432.12,
"revenue": 28450,
"renewalRevenue": 6320,
"refundedRevenue": 410,
"revenuePerVisitor": 2.29,
"conversionRate": 1.15,
"kpiValue": 28450,
"kpiPerVisitor": 2.29,
"kpiConversionRate": 1.15,
"currency": "USD"
}
]
}