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 permiten 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 debes usar el token generado en el paso anterior como encabezado de autorización.

Endpoint:

GET https://sensores-api.wivoanalytics.com/objects
Authorization: <token>

Ejemplo de respuesta:

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

Paso 3: Consultar visitas de tiendas

Endpoint:

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>
Authorization: <token>

Parámetros

Parámetro	Descripción	Formato	Obligatorio
`start`	Fecha a partir de la cual se quieren obtener las visitas	`YYYY-MM-DDThh:mm:ss`	Sí
`end`	Fecha hasta la cual se quieren obtener las visitas	`YYYY-MM-DDThh:mm:ss`	Sí
`resolution`	Granularidad de la consulta (día u hora)	`day` \| `hour`	Sí
`object`	ID de la tienda	numérico	Sí
`old_id`	Indica si se desean los IDs de la plataforma antigua	`true` \| `false`	No
`external`	Entrega el flujo externo de la tienda	`true` \| `false`	No

Límite del período

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

Errores

Código	Descripción
`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`	Métrica solicitada no reconocida
`error: {}`	Error interno

Legado: consultas con IDs de plataforma antigua

Tanto las consultas de tiendas como las de visitas pueden solicitarse con los IDs originales agregando el parámetro old_id=true.

Ejemplos:

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=true

GET https://sensores-api.wivoanalytics.com/objects?old_id=true