API de visitas

‍

Wivo ofrece una API que permite consultar las visitas de las tiendas con el servicio de sensores contadores de personas. Las consultas de visitas permite obtener respuestas con granularidad horaria o diaria.

Paso 1: Obtener token

‍

Puedes obtener el token en la sección API de la aplicación web una vez que ingresas a sensores.wivoanalytics.com.

‍Importante: Solo los usuarios administradores tienen acceso a esta vista.

‍

Este token será utilizado en todas las consultas.

Paso 2: Listar tiendas

Para consultar las tiendas deberás usar el token generado en el paso anterior como encabezado de autorización.

GET https://sensores-api.wivoanalytics.com/objects

‍
Header : Authorization:<token>

Ejemplo de petición para las tiendas:

Ejemplo de respuesta:

[   
	{      
		"id": 3498,
		"name": "Tienda A"
	},   
	{
		"id": 317,
		"name": "Tienda B"
	}  
]

Paso 3: consultar visitas de tiendas

Para consultar las visitas de las tiendas deberás, en primer lugar, usar el token generado en el paso anterior como encabezado de autorización. En segundo lugar, deberás indicar la fecha de inicio del rango de consulta, la fecha de término del rango de consulta, la granularidad y el ID de la tienda a consultar.

GET https://sensores-api.wivoanalytics.com/visits?start=<YYYY-MM-DDThh:mm:ss>&end=<YYYY-MM-DDThh:mm:ss>&resolution=<day|hour>&object=<IdTienda>&old_id=<true|false>&external=<true|false>

Header : Authorization:<token>

‍

Parámetro	Descripción	Formato	Obligatorio
start	Fecha a partir de la cual se quieren obtener las visitas	YYYY-MM-DDThh:mm:ss	Si
end	Fecha hasta la cual se quieren obtener las visitas	YYYY-MM-DDThh:mm:ss	Sí
resolution	Indica la granularidad de la consulta, que puede ser por día (day) o por hora (hour)	day\|hour	Sí
object	id Tienda de la tienda por la cual se están consultando las visitas	numérico	Sí
old_id	indica sí se desean los ids de las tiendas de la plataforma antigua	numérico	No
external	Entrega el flujo externo de la tienda	numérico	No

Limite del periodo:

hour: 1 mes (desde start a end)
day: 1 año (desde estar a end)

Errores:

parameters-incompleted: No se han pasado los parámetros obligatorios esperados
no-authentication-provided: Se ha olvidado el token
invalid-token: token vencido
error: Métrica desconocida
error: {} Error interno

‍

Legado: Consultas de Ids de plataforma antigua

Tanto las consultas de las tiendas como las consultas de visitas pueden solicitarse con los ids originales de la plataforma antigua añadiendo el parámetro old_id=true. Ejemplo:

GET https://sensores-api.wivoanalytics.com/visits?resolution=hour&object=7&start=2023-04-01T00:00:00&end=2023-04-30T00:00:00&old_id

GET https://sensores-api.wivoanalytics.com/objects&old_id

API de visitas

Paso 1: Obtener token

Paso 2: Listar tiendas

Paso 3: consultar visitas de tiendas

Legado: Consultas de Ids de plataforma antigua

Aplicación Móvil

Wivo Analytics

Herramientas