Nova API V1.0 · Referência
Retenção de clientes
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.
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.
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.
Granularidade: daily = diária; monthly = mensal. Padrão: diária.
Início do período (YYYY-MM-DD). No KDS também aceita ISO com timezone. Obrigatório quando granularity=daily; ignorado no modo mensal.
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. Obrigatório quando granularity=daily; ignorado no modo mensal.
Primeiro mês (YYYY-MM). Obrigatório quando granularity=monthly; ignorado nos outros modos.
Último mês (YYYY-MM). Obrigatório quando granularity=monthly; ignorado nos outros modos.
Canal de venda do relatório de origem.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Resumo de clientes 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.
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.