Coleta de Dados de Fluxo 🚶

Introdução

Segue uma apresentação rápida e direta para coleta do dados de fluxos. Para mais informações, acesse a Documentação da API.

Base URL:

https://api.painelalter.com/api/

Todas as requisições iniciam com essa URL base e a rota é adicionada ao final.

Exemplo:

https://api.painelalter.com/api/v2/count
https://api.painelalter.com/api/v2/countAdjusted

Autenticação

Para usar a API, é necessário informar um cabeçalho de autorização usando autentificação Basic. Ou seja, é necessário informar o username e senha em todas as requisições.

Exemplo

Usando Postman, selecione Authorization → Basic Auth e insira suas credenciais.

Endpoints

/count

Esse endpoint retorna dados de fluxo ordenados pelos dispositivos considerando o intervalo de datas selecionado. Mostra exatamente o resultado captura pelos dispositivos, sem ajustes.

/countAdjusted

Esse endpoint retorna os dados de fluxo ajustados, incluindo, portanto, ajustes de acordo com a disponibilidade. Recomendamos utilizar essa informação para uso em relatórios e análises.

Parâmetros da Query

Parâmetro	Descrição
dateBegin	Data Início. Formato YYYY-MM-DD (Inclusivo)
dateEnd	Data Fim. Formato YYYY-MM-DD (Inclusivo)
eventType	Id do tipo de evento a ser recuperado (1=fluxo de entrada)
groupBy	Parâmetro de agrupamento dos dados

Tabela de Ids tipo de evento

EventType	Descrição
1	Fluxo de Entrada
2	Fluxo de saída
3	Parada no Caixa
4	Fluxo externo Esquerda
5	Fluxo externo Direita
6	Entrada de Funcionário
7	Saída de Funcionário
8	Entrada de veículo
9	Saída de veículo
10	Fluxo dentro da loja
11	Entrada de grupo de pessoas

Tabela de nomes do groupBy

groupBy	Descrição
day	Agrupar por dia
month	Agrupar por mês
hour	Agrupar por hora
weekday	Agrupar por dia da semana
day-hour	Agrupar por dia e hora