GymMaster: KPI, Reporting and Dashboard API V2 (v1320)

Download OpenAPI specification:Download

KPI

KPI summary statistics. Equivalent to data in Report & Till -> Key Performance Indicators

KPI Categories List

All the available categories that are used to group together KPI fields

Authorizations:

api_key_queryapi_key_header

Responses

Response samples

200

Content type

application/json

{"result": ["member_statistics",
"member_activity",
"membership_activity",
"sales_made",
"payment_method",
"booking_summary",
"class_summary"
],
"error": null
}

KPI - Filter By Category

Uses an array of categories to grab values. These values may be grouped by category or left in one large array.

Authorizations:

api_key_queryapi_key_header

Request Body schema: application/json

api_request

required	object (DateFilter)
selected_categories required	Array of strings (Selected Categories)
grouped_categories	boolean (Grouped Categories) Default: true

Responses

Request samples

Payload

Content type

application/json

{"date": {"start": "2024-06-01",
"end": "2024-07-01"
},
"selected_categories": ["sales_made",
"class_summary"
],
"grouped_categories": true
}

Response samples

200

Content type

application/json

Example

Grouped

{"result": {"sales_made": [{"money": {"name": "Total Sales",
"id": 1,
"metric": "money",
"quantity": 0,
"taxvalue": "$0.00",
"tooltip": null,
"value": 0,
"formatted_value": "$0.00"
}
}
],
"class_summary": [{"attendees": {"name": "Total class attendants",
"id": 1,
"metric": "attendees",
"quantity": null,
"taxvalue": null,
"tooltip": null,
"value": 0,
"formatted_value": "0 attendees"
}
}
]
},
"error": [ ]
}

KPI Fields List

All the available Categories that are used to group together KPI fields.

Authorizations:

api_key_queryapi_key_header

Responses

Response samples

200

Content type

application/json

{"result": ["current_members",
"female_members",
"male_members",
"average_age",
"hold_members_gifted",
"hold_members_not_gifted",
"avg_holdtime",
"avg_member_time",
"new_memberships",
"renewed_memberships",
"expiring_memberships",
"cancellations_period_by_reason",
"membership_retention"
],
"error": null
}

KPI - Filter By Fields

Get individual kpi fields for a given date. These fields may return single set of values, as is found in the Members Statistics group, or return an array of values - (Sales Made Group)

Authorizations:

api_key_queryapi_key_header

Request Body schema: application/json

filter

required	object (DateFilter)
selected_fields required	Array of strings (Selected Fields)

Responses

Request samples

Payload

Content type

application/json

{"date": {"start": "2024-06-01",
"end": "2024-07-01"
},
"selected_fields": ["current_members",
"new_memberships"
]
}

Response samples

200

Content type

application/json

{"result": {"current_members": {"name": "Current members",
"id": 1,
"metric": "members",
"quantity": null,
"taxvalue": null,
"tooltip": "Includes anyone who has been a current member in this period. Some may have expired or were cancelled, but were current at one stage during the period",
"value": 164,
"formatted_value": "164 members"
},
"new_memberships": {"name": "New memberships signed up",
"id": 1,
"metric": "memberships",
"quantity": null,
"taxvalue": null,
"tooltip": "Memberships Sold in the specified time period",
"value": 0,
"formatted_value": "0 memberships"
}
},
"error": [ ]
}

Report

API equivalents to Report & Till -> Standard Report page

Available Reports

List of all the available report names and their ID's

Authorizations:

api_key_queryapi_key_header

query Parameters

predefined_only

any

Exclude copies of reports generated by the user. Defaults to true. Query parameter value if supplied will be coerced to a boolean

Responses

Response samples

200

Content type

application/json

{"result": [{"id": 1,
"name": "Current Members",
"category": "Member"
},
{"id": 9,
"name": "All Bookings",
"category": "Booking"
}
],
"error": null
}

Run Report

Generate the same data as if running a report through Report and Till -> Standard Report

Authorizations:

api_key_queryapi_key_header

Request Body schema: application/json

api_request

start_date required	string (Start Date) ISO date string
end_date required	string (End Date) ISO date string
report_id required	integer (Report Id)
	Company Id (integer) or Company Id (null) (Company Id) Default: null
displaymode	string (Displaymode) Default: "CURRENT" Enum: "CURRENT" "ALL" "HIDDEN" Affects some member-based reports. Controls whether "casual"/"hidden" memberships are included in the returned data
required_columns	Array of strings (Required Columns) List of field names that should be added to the report

Responses

Request samples

Payload

Content type

application/json

{"start_date": "2024-06-01",
"end_date": "2024-07-01",
"report_id": 0,
"company_id": null,
"displaymode": "CURRENT",
"required_columns": ["Member ID",
"Member Name"
]
}

Response samples

200

Content type

application/json

{"result": [{"Member ID": 1234,
"Member Name": "Alice"
},
{"Member ID": 1234,
"Member Name": "Bob"
}
],
"error": null,
"cached_result": false
}

Dashboard

Endpoints for showing data used on the home page dashboard

Dashboard List

List of all dashboard endpoints

Authorizations:

api_key_queryapi_key_header

Responses

Response samples

200

Content type

application/json

{"result": [{"type": "kpi",
"endpoint": "kpi.member_new"
},
{"type": "graph",
"endpoint": "kpi.member_bookings"
}
],
"error": null
}

Run Dashboard Endpoint

Takes a single dashboard endpoint name. The dashboard fields are calculated based off the current date. There is no passing in of dates for this endpoint.

Authorizations:

api_key_queryapi_key_header

query Parameters

endpoint

any

An endpoint returned by /dashboard/list

Responses

Response samples

200

Content type

application/json

{"result": { },
"error": "string"
}