Obtener un desglose por cualquier dimensión

api-referenceGET

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

Agrupar visitantes por cualquiera de las 25 dimensiones, incluidas las que no tienen endpoint propio como entry_page, exit_link, browser_version, os_version, via y cada parámetro UTM.

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 websiteId o domain 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

Parámetro	Tipo	Descripción
`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.

Parámetros de consulta

Parámetro	Tipo	Descripción
`dimension`OBLIGATORIO	`string`	El atributo por el que agrupar visitantes: uno de los 25 valores de la lista Dimensiones. Cualquier otro valor devuelve 400.
`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`	Fecha/hora de finalización ISO 8601. El valor predeterminado es ahora cuando se omite.
`timezone`	`string`	Zona horaria para la agregación (por ejemplo, UTC, America/New_York). Recurre a la zona horaria configurada del sitio.
`limit`	`number`	Máximo de filas a devolver (1-1000, predeterminado: 100).
`offset`	`number`	Filas a omitir para paginación (mín. 0, predeterminado: 0).

Dimensiones

Parámetro	Tipo	Descripción
`device`	`string`	Tipo de dispositivo: Desktop, Mobile o Tablet.
`page`	`string`	Ruta de la página.
`entry_page`	`string`	Primera página de la sesión.
`exit_link`	`string`	Enlace saliente en el que el visitante hizo clic para salir del sitio. Los ingresos siempre son 0.
`hostname`	`string`	Nombre de host desde el que se sirvió la página.
`referrer`	`string`	Nombre de la fuente de referencia, como Google, o el dominio para sitios que Flowsery no reconoce. Las filas incluyen iconUrl.
`channel`	`string`	Canal de adquisición, las mismas filas que GET /channels.
`campaign`	`string`	Campaña UTM, las mismas filas que GET /campaigns.
`goal`	`string`	Nombre del objetivo. visitors contiene el número de conversiones y los ingresos siempre son 0.
`country`	`string`	Nombre del país. Las filas incluyen countryCode.
`region`	`string`	Región o estado con su nombre completo, como California. Las filas incluyen countryCode.
`city`	`string`	Nombre de la ciudad. Las filas incluyen countryCode.
`browser`	`string`	Nombre del navegador.
`browser_version`	`string`	Versión del navegador.
`os`	`string`	Sistema operativo.
`os_version`	`string`	Versión del sistema operativo.
`utm_source`	`string`	El parámetro de URL utm_source.
`utm_medium`	`string`	El parámetro de URL utm_medium.
`utm_campaign`	`string`	El parámetro de URL utm_campaign.
`utm_term`	`string`	El parámetro de URL utm_term.
`utm_content`	`string`	El parámetro de URL utm_content.
`ref`	`string`	El parámetro de URL ref.
`source`	`string`	El parámetro de URL source.
`via`	`string`	El parámetro de URL via, habitual en enlaces de afiliados y socios.
`all_params`	`string`	Todos los parámetros de seguimiento de la sesión unidos en un solo valor, como utm_source=google&utm_medium=cpc.

Parámetros de filtro

Parámetro	Tipo	Descripción
`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. Safari incluye Mobile Safari automáticamente.
`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 parámetro de URL ref.
`filter_source`	`string`	El valor del parámetro de URL source.
`filter_via`	`string`	El valor del parámetro de URL via.
`filter_utm_source`	`string`	Fuente UTM.
`filter_utm_medium`	`string`	Medio UTM.
`filter_utm_campaign`	`string`	Campaña UTM.
`filter_utm_term`	`string`	Término UTM.
`filter_utm_content`	`string`	Contenido UTM.
`filter_page`	`string`	Ruta de página o URL.
`filter_entry_page`	`string`	Ruta o URL de página 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 del array data contiene el valor agrupado en value, el número de visitantes, los ingresos divididos en newRevenue y renewalRevenue, y su parte de los visitantes en percentage. Las dimensiones geográficas añaden countryCode y referrer añade iconUrl. Un valor que no se capturó se devuelve como Unknown.

Los valores coinciden con los filtros

Los valores se devuelven con el formato que esperan los parámetros filter_*, así que puedes reenviar cualquier fila como filtro. Las regiones son nombres completos (California, no CA), los dispositivos empiezan en mayúscula (Desktop, Mobile, Tablet) y los referentes son nombres de fuente (Google, no google.com).

Combinar filtros

Separa varios valores dentro de un mismo parámetro de filtro con |. Combina una dimensión con filtros para responder preguntas más concretas (p. ej., dimension=via&filter_country=United States&filter_device=Mobile).

Solicitud de ejemplo (Curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "partner_anna",
      "visitors": 640,
      "revenue": 2310,
      "newRevenue": 1980,
      "renewalRevenue": 330,
      "percentage": 51.2
    },
    {
      "value": "partner_marc",
      "visitors": 410,
      "revenue": 1270,
      "newRevenue": 1270,
      "renewalRevenue": 0,
      "percentage": 32.8
    },
    {
      "value": "podcast",
      "visitors": 200,
      "revenue": 380,
      "newRevenue": 290,
      "renewalRevenue": 90,
      "percentage": 16
    }
  ],
  "pagination": {
    "limit": 3,
    "offset": 0,
    "total": 14
  }
}