Obtener analítica por país

api-referenceGET

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

Obtener datos de analisis segmentados por pais.

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 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 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 del pais, una URL de imagen SVG de la bandera, el conteo de visitantes y los ingresos atribuidos a ese pais.

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,Canada&filter_device=mobile</code>).

Solicitud de ejemplo (curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/countries?limit=5' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "United States",
      "countryCode": "US",
      "visitors": 2840,
      "revenue": 6780,
      "renewalRevenue": 1740,
      "percentage": 44.1
    },
    {
      "value": "France",
      "countryCode": "FR",
      "visitors": 1230,
      "revenue": 2450,
      "renewalRevenue": 530,
      "percentage": 19.1
    },
    {
      "value": "United Kingdom",
      "countryCode": "GB",
      "visitors": 920,
      "revenue": 1450,
      "renewalRevenue": 320,
      "percentage": 14.3
    },
    {
      "value": "Germany",
      "countryCode": "DE",
      "visitors": 780,
      "revenue": 1230,
      "renewalRevenue": 210,
      "percentage": 12.1
    },
    {
      "value": "Spain",
      "countryCode": "ES",
      "visitors": 650,
      "revenue": 980,
      "renewalRevenue": 140,
      "percentage": 10.1
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 148
  }
}