Search Aggregator Check-in Report

Description

Returns the report of check-ins performed through aggregators, allowing filtering by origin branch, check-in branch, period (start and end date), and aggregator list. The result supports pagination through the Take and Skip parameters.

🔑 Query Parameters

Parameter	Type	Required	Description
DtStart	date-time	No	Start date to filter the check-in period.
DtEnd	date-time	No	End date to filter the check-in period.
IdBranch	int32	No	Filter by the check-in branch.
IdBranchOrigin	int32	No	Filter by the origin branch where the member or prospect is registered.
CheckinBranchIds	array	No	List of branch IDs where the check-ins occurred.
Aggregators	array	No	List of aggregators. See options below.
Skip	int32	No	Number of records to skip in the list (pagination).
Take	int32	No	Number of records to return (pagination). Default: 25. Maximum: 50.

🔷 aggregators Enum

Value	Aggregator
1	Wellhub (Gympass)
2	Totalpass
7	Gurupass
9	GoGood

📤 Response Structure

The response returns the total number of records found and a paginated list of check-ins performed through aggregators, including member or prospect information, origin branch, branch where the check-in occurred, date, status, product, token used, and aggregator.

Field	Type	Description
total	int32	Total number of records found based on the provided filters.
list	array	List of aggregator check-ins returned in the query.

🧩 list Object

Field	Type	Description
idMember	int32	ID of the member linked to the check-in, when applicable.
idProspect	int32	ID of the prospect linked to the check-in, when applicable.
name	string	Name of the member or prospect who performed the check-in.
originBranchId	int32	ID of the origin branch where the member or prospect is registered.
originBranchName	string	Name of the origin branch where the member or prospect is registered.
checkinBranchId	int32	ID of the branch where the check-in was performed.
checkinDate	date-time	Check-in date and time in ISO 8601 format.
checkinTime	string	Check-in time.
status	string	Check-in status.
product	string	Product related to the aggregator check-in.
tokenUsed	string	Token used to validate or register the check-in.
aggregator	string	Name of the aggregator responsible for the check-in.