Analytics
Usage analytics, reporting, and audit trails.
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startTimestring · date-timeOptional
endTimestring · date-timeOptional
areaIdstring[]OptionalExample:
["les","w37"]Responses
200
Returns a AnalyticsUsersStats
application/json
totalnumberRequired
newnumberRequired
newPercentnumberRequired
activenumberRequired
totalMembersnumberRequired
totalMembershipsnumberRequired
newMembershipsnumberRequired
newMembershipsPercentnumberRequired
get/tenants/current/analytics/users
GET /apis/v2/tenants/current/analytics/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a AnalyticsUsersStats
{
"total": 1,
"new": 1,
"newPercent": 1,
"active": 1,
"totalMembers": 1,
"totalMemberships": 1,
"newMemberships": 1,
"newMembershipsPercent": 1
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
userIdstringRequired
Query parameters
startTimestring · date-timeOptional
endTimestring · date-timeOptional
Responses
200
Returns a AnalyticsUserStats
application/json
_totalnumberRequired
get/tenants/current/analytics/users/{userId}
GET /apis/v2/tenants/current/analytics/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a AnalyticsUserStats
{
"items": [
{
"year": 1,
"month": 1,
"visits": 1,
"events": 1,
"bookings": 1,
"charged": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startTimestring · date-timeOptional
endTimestring · date-timeOptional
Responses
200
Returns a AnalyticsPodUtilisationStatsCollection
application/json
_totalnumberRequired
get/tenants/current/analytics/utilisation
GET /apis/v2/tenants/current/analytics/utilisation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a AnalyticsPodUtilisationStatsCollection
{
"items": [
{
"id": "text",
"pod": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"totalAvailableHs": 1,
"operationsHs": 1,
"regularHs": 1,
"openPlayHs": 1,
"leagueNightHs": 1,
"tournamentHs": 1,
"partyHs": 1,
"classesHs": 1,
"privateEventHs": 1,
"membersHs": 1,
"nonMembersHs": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
startTimestring · date-timeOptional
endTimestring · date-timeOptional
Responses
200
Returns a AnalyticsPodRevenueStatsCollection
application/json
_totalnumberRequired
get/tenants/current/analytics/revenue
GET /apis/v2/tenants/current/analytics/revenue HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Returns a AnalyticsPodRevenueStatsCollection
{
"items": [
{
"id": "text",
"area": {
"id": "text"
},
"pod": {
"id": "text"
},
"startTime": "2026-01-01T00:00:00.000Z",
"endTime": "2026-01-01T00:00:00.000Z",
"total": 1,
"reservations": 1,
"eventSignups": 1,
"memberships": 1,
"coaching": 1,
"replays": 1,
"campsAndClasses": 1,
"products": 1
}
],
"_total": 1,
"_links": {
"self": {
"href": "text"
}
}
}Last updated
Was this helpful?

