Nova API V1.0 · Referência
Clientes por atividade
Consulta de leitura equivalente à manager-api. Exige reports:customers:read e restaurante autorizado. Filtros, valores e paginação mantêm o contrato do serviço de relatórios. Não concede permissões novas a tokens existentes.
Consulta de leitura equivalente à manager-api. Exige reports:customers:read e restaurante autorizado. Filtros, valores e paginação mantêm o contrato do serviço de relatórios. Não concede permissões novas a tokens existentes.
Authorization
reportsIntegration Access token obtido por OAuth ou troca de API key. Exige reports:payments:read, reports:customers:read, reports:products:read ou reports:kds:read conforme a rota. Não aceita sessões humanas, tokens de garçom ou chaves brutas.
In: header
Query Parameters
Restaurante autorizado pela credencial. Obrigatório quando houver mais de um restaurante; sem seleção implícita para credenciais universais.
Início do período (YYYY-MM-DD). No KDS também aceita ISO com timezone.
Fim do período (YYYY-MM-DD). KDS inclui o dia civil de Brasília; com ISO, o instante final é exclusivo. KDS: máximo 92 dias.
Segmento de atividade do cliente.
Canal de venda do relatório de origem.
Origem dos clientes.
Filtro de quantidade de visitas.
Modo de seleção dos clientes.
Filtro de presença de telefone.
Cursor opaco retornado em data.next_cursor. Omitir na primeira página; null encerra a paginação.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Retenção por frequência de visitas GET
Consulte a série de clientes por dia ou por mês usando granularity. Informe as datas ou os meses correspondentes à escolha. Exige reports:customers:read e restaurante autorizado; preserva o corpo e os cálculos da variante selecionada. Veja exemplos no guia de relatórios.
Funil de visitas GET
Consulta de leitura equivalente à manager-api. Exige reports:customers:read e restaurante autorizado. Filtros, valores e paginação mantêm o contrato do serviço de relatórios. Não concede permissões novas a tokens existentes.