Buscar Relatório de Check-ins de Agregadores

Descrição

Retorna o relatório de check-ins realizados por agregadores, permitindo filtragem por filial de origem, filial de check-in, período (data inicial e final) e lista de agregadores. O resultado suporta paginação através dos parâmetros take e skip.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
DtStart	date-time	Não	Data inicial para filtro do período do check-in.
DtEnd	date-time	Não	Data final para filtro do período do check-in.
IdBranch	int32	Não	Filtrar pela filial de check-in.
IdBranchOrigin	int32	Não	Filtrar pela filial de origem onde o membro ou prospect está cadastrado.
CheckinBranchIds	array	Não	Lista de IDs de filiais onde ocorreram o check-in.
Aggregators	array	Não	Lista de agregadores. Ver opções abaixo.
Skip	int32	Não	Quantidade de registros a serem ignorados na listagem (paginação).
Take	int32	Não	Quantidade de registros a serem retornados (paginação). Padrão: 25. Máximo: 50.

🔷 Valores de aggregators

Valor	Agregador
1	Wellhub (Gympass)
2	Totalpass
7	Gurupass
9	GoGood

📤 Estrutura da Resposta

A resposta retorna o total de registros encontrados e uma lista paginada com os check-ins realizados por agregadores, incluindo informações do membro ou prospect, filial de origem, filial onde ocorreu o check-in, data, status, produto, token utilizado e agregador.

Campo	Tipo	Descrição
total	int32	Quantidade total de registros encontrados com base nos filtros informados.
list	array<object>	Lista de check-ins de agregadores retornados na consulta.

🧩 Objeto list

Campo	Tipo	Descrição
idMember	int32	ID do membro vinculado ao check-in, quando aplicável.
idProspect	int32	ID do prospect vinculado ao check-in, quando aplicável.
name	string	Nome do membro ou prospect que realizou o check-in.
originBranchId	int32	ID da filial de origem onde o membro ou prospect está cadastrado.
originBranchName	string	Nome da filial de origem onde o membro ou prospect está cadastrado.
checkinBranchId	int32	ID da filial onde o check-in foi realizado.
checkinDate	date-time	Data e hora do check-in no formato ISO 8601.
checkinTime	string	Horário do check-in.
status	string	Status do check-in.
product	string	Produto relacionado ao check-in do agregador.
tokenUsed	string	Token utilizado para validação ou registro do check-in.
aggregator	string	Nome do agregador responsável pelo check-in.