Takeat
Versão da documentação
RelatóriosClientes

Nova API V1.0 · Referência

Clientes por etapa de visitas

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.

Console de requisiçõesConfigure os dados, envie e inspecione a resposta.
GETProxy seguro
RequisiçãoEdite os campos antes de enviar
GET
/v1/reports/customers/visit-retention/customers

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
AuthorizationBearer <token>

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

restaurant_id?string

Restaurante autorizado pela credencial. Obrigatório quando houver mais de um restaurante; sem seleção implícita para credenciais universais.

cohort_start_date*string

Início da coorte (YYYY-MM-DD).

cohort_end_date*string

Fim da coorte (YYYY-MM-DD).

stage?string

Etapa da retenção por visitas.

mode?string

Modo de seleção dos clientes.

origin?string

Origem dos clientes.

channel?string

Canal de venda do relatório de origem.

has_phone?string

Filtro de presença de telefone.

cursor?string

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