Obtener resumen del sitio

api-referenceGET

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

Obtener metricas de analisis agregadas para su sitio web.

Token Bearer (token de workspace o clave API de sitio web)

Los tokens de espacio de trabajo necesitan un selector de sitio web

Los tokens de API del espacio de trabajo pueden acceder a todos los sitios web del espacio de trabajo. Pase <code>websiteId</code> o <code>domain</code> para que Flowsery sepa qué sitio web consultar o mutar. Las claves API del sitio web ya están destinadas a un sitio web, por lo que se puede omitir el selector.

Selector de sitios web

Parametro	Tipo	Descripcion
`websiteId`	`string`	ID del sitio web para usar con un token de API del espacio de trabajo. Omitir al autenticarse con una clave API de sitio web.
`domain`	`string`	Sitio web domain para usar con un token API de espacio de trabajo cuando no se proporciona websiteId. Omitir al autenticarse con una clave API de sitio web.

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`	Fecha/hora de finalización ISO 8601. El valor predeterminado es ahora cuando se omite.
`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 del país tal como lo devuelve /countries, p. ej. United States. Usa \| para varios valores, ! para excluir y ~ para una coincidencia parcial.
`filter_region`	`string`	Nombre de la región o el estado tal como lo devuelve /regions, p. ej. California.
`filter_city`	`string`	Nombre de ciudad.
`filter_device`	`string`	Tipo de dispositivo: Desktop, Mobile o Tablet. Los valores distinguen mayúsculas y minúsculas.
`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`	Referente tal como lo devuelve /referrers: un nombre de fuente como Google para los sitios reconocidos y, si no, el dominio.
`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

Si no se indica un rango de fechas, la API usa los últimos 30 días hasta ahora. bounceRate y conversionRate son porcentajes; avgSessionDuration y avgEngagedTime están en segundos. Los valores de filtro aceptan | para varios valores, ! para excluir y ~ para una coincidencia parcial.

Solicitud de ejemplo (curl)

curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/overview \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890,
      "bounceRate": 65.32,
      "avgSessionDuration": 246,
      "avgEngagedTime": 187,
      "revenue": 28450,
      "renewalRevenue": 6320,
      "refundedRevenue": 410,
      "revenuePerVisitor": 2.29,
      "conversionRate": 1.15,
      "kpiValue": 28450,
      "kpiPerVisitor": 2.29,
      "kpiConversionRate": 1.15,
      "currency": "USD"
    }
  ]
}