API de visitas

A Wivo oferece uma API que permite consultar as visitas das lojas com o serviço de sensores contadores de pessoas. As consultas de visitas permitem obter respostas com granularidade horária ou diária.

Passo 1: obter o token

Você pode obter o token na seção API do aplicativo web depois de entrar em sensores.wivoanalytics.com.

Importante: apenas usuários administradores têm acesso a essa visão.

Este token será utilizado em todas as consultas.

Passo 2: listar lojas

Para consultar as lojas você deve usar o token gerado no passo anterior como cabeçalho de autorização.

Endpoint:

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

Exemplo de resposta:

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

Passo 3: consultar visitas das lojas

Endpoint:

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

Parâmetros

Parâmetro	Descrição	Formato	Obrigatório
`start`	Data a partir da qual se deseja obter as visitas	`YYYY-MM-DDThh:mm:ss`	Sim
`end`	Data até a qual se deseja obter as visitas	`YYYY-MM-DDThh:mm:ss`	Sim
`resolution`	Granularidade da consulta (dia ou hora)	`day` \| `hour`	Sim
`object`	ID da loja	numérico	Sim
`old_id`	Indica se você quer os IDs da plataforma antiga	`true` \| `false`	Não
`external`	Retorna o fluxo externo da loja	`true` \| `false`	Não

Limite do período

hour: 1 mês (de start a end)
day: 1 ano (de start a end)

Erros

Código	Descrição
`parameters-incompleted`	Não foram informados os parâmetros obrigatórios esperados
`no-authentication-provided`	O token foi esquecido
`invalid-token`	Token vencido
`error: Métrica desconocida`	Métrica solicitada não reconhecida
`error: {}`	Erro interno

Legado: consultas com IDs da plataforma antiga

Tanto as consultas de lojas quanto as de visitas podem ser feitas com os IDs originais adicionando o parâmetro old_id=true.

Exemplos:

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