Reporting Quickstart

This guide provides detailed instructions for using the Reporting API to generate various reports for your platform.

API Endpoint

The Reporting API uses a single GET endpoint. The structure of the request is as follows:

Method: GET

URL:

https://report-api.unifiedfitnessplatform.ai/tenants/{tenant_id}/reports/{report_key}

Authentication

(please refer to QuickStart guide for Auth)

Parameter Details

The endpoint uses a combination of path and query parameters to specify and filter the report.

1. Path Parameters

Parameter	Type	Required	Description
`tenant_id`	integer	Yes	The unique identifier for the tenant.
`report_key`	string	Yes	The unique key for the report you want to run. See the "Available Reports" table below for a full list.

2. Query Parameters

Parameter	Type	Required	Description
`rpt_fltr_relative_date_range`	string	No	A predefined date range for the report. If used, you do not need to specify `from_date` and `to_date` in the payload. Available values: `Today`, `Tomorrow`, `ThisMonth`, `ThisQuarter`, `CustomDateRange`, `LastThirtyDays`, `LastSevenDays`, `LastMonth`, `Yesterday`.
`rpt_fltr_payload`	string	Yes	A stringified JSON object containing the filters for the report. This is the main body of your filter criteria.

Constructing the `rpt_fltr_payload`

The rpt_fltr_payload must be a URL-encoded string of a JSON object.

Common Payload Parameters

These parameters are available for most reports and are used for pagination, date filtering (if not using rpt_fltr_relative_date_range), and localization.

time_zone (string): The target time zone (e.g., "India Standard Time").

page_no (integer): The page number for the results.

page_size (integer): The number of results to return per page.

from_date (string): The start date for the report in YYYY-MM-DDTHH:mm:ss.sssZ format. Required if using CustomDateRange.

to_date (string): The end date for the report in YYYY-MM-DDTHH:mm:ss.sssZ format. Required if using CustomDateRange.

localized_value (boolean): true to return localized enum values.

language_code (string): The language code (e.g., "en") for localization.

Additional Parameters

Most reports may have additional parameters to filter and are specific to that report. These are listed in the table below.

Available Reports

This table provides the report_key, name, description, and the additional, non-common parameters required inside the rpt_fltr_payload for each report.

report_key	Report Name	Report Description	Additional Payload Parameters
`SubscriptionSignUpReport`	Subscription SignUp Report	Get the subscription sign up report	`plan_id`, `plan_subscription_category`, `created_by`, `sales_rep`, `str_tenant_ids`
`ClientListReport`	Client List Report	N/A	`full_name`, `home_club_id`
`PaymentReport`	Payment Report	Get the payment report	`str_payment_mode_level_1`, `str_payment_status`, `sales_rep`, `str_tenant_ids`
`SubscriptionDetailReport`	Subscription Detail Report	Get the subscription detail report	`subscription_status`, `created_by`, `sales_rep`, `str_tenant_ids`
`InProgressSubscriptionSignups`	Subscription Signup - In-progress Report	This report will show list of all subscriptions which are still in-porgress.	`plan_id`, `str_tenant_ids`
`ChargesFees`	Charges & Fees report	This report will show all Charges and fees charged during a selected period	`category_id`, `str_tenant_ids`
`FailedSubscriptionSignups`	Subscription Signup - Failed Report	This report will show all failed and expired signups	`plan_id`, `str_tenant_ids`
`CompletedTasksByStaff`	Task Completed by Staff Report	N/A	`staff_id`
`SubscriptionExpired`	Subscription Expired Report	This report will show list of all Subscriptions that are expired in a given date range	`str_tenant_ids`
`SubscriptionNotRenewing`	Subscription not Renewing Report	This report will show list of all Subscriptions that are due for Renewaing in a given date range	`staff_id`, `created_by`, `sales_rep`
`WonBackClient`	Won Back Client Report	This report will show list of all won back clients in a given date range	`staff_id`
`ChurnClient`	Churn Client Report	This report will show list of all churned clients in a given date range	`staff_id`
`AppointmentByCoach`	Appointment By Coach Report	This report will show list of all Appointments conducted within the given date range by a specifc coach	`coach_id`
`AppointmentByCategory`	Appointment By Category Report	This report will show list of all Appointments conducted within the given date range by category	`category_id`
`CancelledAppointmentByCategory`	Cancelled Appointment By Category Report	This report will show list of all cancelled Appointments conducted within the given date range by category	`category_id`
`ClientCheckIns`	Client Check Ins Report	This report will show list of all checkins conducted within the given date range by event type and access status	`event_type`, `access_status`
`NewJoinerClient`	New Joiner Client Report	New Joiner Client Report	`include_rejoin`, `include_drop_in`, `plan_id`
`InvoiceSummary`	Invoice Summary Report	A detailed overview of all Invoices created in a given time period.	`sales_rep`, `str_inv_status`, `created_by`, `str_tenant_ids`
`ClassAttendance`	Class Attendance Report	Get the class attendance report	`class_type_id`, `coach_id`, `class_type_behaviour`, `class_booking_status`
`ClassSummary`	Class Summary Report	Get the class summary report	`class_type_name_company_level`, `coach_id`, `class_type_behaviour`, `class_status`, `str_tenant_ids`
`SalesByServiceCategory`	Sales By Service Category Report	Get the sales by service category wise	`plan_id`, `sales_rep`, `category_id`, `str_tenant_ids`
`InvoiceDetail`	Invoice Details Report	Get the sales	`str_tenant_ids`
`ARAgingSummaryByClient`	AR Aging Summary By Client Report	AR Aging summary by clients Report	`clt_client_rep_id`, `balance_greater_than`, `as_on_date`, `number_of_aging_intervals`, `aging_interval_period_grouping_in_days`
`ARAgingDetailReport`	AR Aging Detail Report	AR Aging details Report	`sales_rep`, `balance_greater_than`, `as_on_date`, `number_of_aging_intervals`, `aging_interval_period_grouping_in_days`
`DiscountReport`	Discount Report	This report will fetch values from invoice line item and invoice entity and show all the discounted invoiced	`plan_id`, `sales_rep`, `str_tenant_ids`
`TaskDone`	Task Done Report	This report will show list of all CRM tasks with specified date range by CRM task category and staff	`category_id`, `staff_id`
`ClientCreditBalance`	Client Credit Balance Report	This report will show the client current credit balance tenant wise	`clt_client_rep_id`, `balance_greater_than`, `str_tenant_ids`
`MembershipRenewedReport`	Membership Renewed Report	This report will show all the clients whose membership has been renewed	`clt_client_rep_id`, `category_id`
`MembershipExpiredReport`	Membership Expired Report	This report will show all the clients whose membership is expiring and is not renewed	`clt_client_rep_id`, `category_id`, `str_tenant_ids`
`CreditBalanceTransactionReport`	Credit Balance Transaction Report	This report will show all the clients credit debit transaction entry	`staff_id`, `credit_balance_transaction_type`, `str_tenant_ids`
`ClientsByServiceCategory`	Clients By Service Category	This report will show all the clients list by Service Category	`clt_client_rep_id`, `client_channel`, `as_on_date`, `client_source`, `client_status`, `category_id`
`SalesReturnDetailReport`	Sales Return Report	This report will show all the sales return done.	`str_tenant_ids`
`EmailTransactionReport`	Email Transaction Report	This report will show all the email transaction detail report	`str_tenant_ids`, `email_transaction_status`
`SMSTransactionReport`	SMS Transaction Report	This report will show all the sms transaction detail report	`str_tenant_ids`, `sms_transaction_status`
`WhatsAppTransactionReport`	Whatsapp Transaction Report	This report will show all the whatsapp transaction detail report	`str_tenant_ids`, `whatsapp_transaction_status`
`PaymentTransactionReport`	Payment Transaction Report	N/A	`payment_mode_level_1_single`, `payment_log_derived_status`, `sales_rep`, `str_tenant_ids`
`CountByMemberCategoryWise`	Historical Client by service category	N/A	`service_category_name`, `include_non_base_membership`, `str_tenant_ids`
`ClientTrialReport`	Client Trial Report	This report will display all clients, including their trial count and conversion status.	`trial_type`, `conversion`, `str_tenant_ids`
`InvoiceAndPaymentDetails`	Invoice Detail Report	This report will show all the invoices and its payments	Not Specified
`ServiceCategoriesAndChargesPayments`	N/A	This report will show all the service categories and charges and its payments	Not Specified
`MembershipDetails`	Membership Report	This report will show all the membership details	Not Specified
`LLCValueReport`	N/A	N/A	Not Specified

Example Request

Here is a complete example of how to run the PaymentReport for tenant 123, for payments made in the last seven days.

1. Construct the Payload Object:
First, create the JSON object with all the necessary filters.

{
  "time_zone": "India Standard Time",
  "page_no": 1,
  "page_size": 50,
  "localized_value": false,
  "language_code": "en",
  "str_payment_mode_level_1": null,
  "str_payment_status": "Completed",
  "sales_rep": null,
  "str_tenant_ids": "123"
}

2. Stringify the Payload:
Convert the JSON object into a single string.

"{\"time_zone\":\"India Standard Time\",\"page_no\":1,\"page_size\":50,\"localized_value\":false,\"language_code\":\"en\",\"str_payment_mode_level_1\":null,\"str_payment_status\":\"Completed\",\"sales_rep\":null,\"str_tenant_ids\":\"123\"}"

3. URL-Encode the Stringified Payload:
This step is critical. The string must be URL-encoded to be safely passed in the URL.

%7B%22time_zone%22%3A%22India%20Standard%20Time%22%2C%22page_no%22%3A1%2C%22page_size%22%3A50%2C%22localized_value%22%3Afalse%2C%22language_code%22%3A%22en%22%2C%22str_payment_mode_level_1%22%3Anull%2C%22str_payment_status%22%3A%22Completed%22%2C%22sales_rep%22%3Anull%2C%22str_tenant_ids%22%3A%22123%22%7D

4. Assemble the Final URL:
Combine the base URL, path parameters, and query parameters to create the final request URL.

https://report-api.unifiedfitnessplatform.ai/tenants/123/reports/PaymentReport?rpt_fltr_relative_date_range=LastSevenDays&rpt_fltr_payload=%7B%22time_zone%22%3A%22India%20Standard%20Time%22%2C%22page_no%22%3A1%2C%22page_size%22%3A50%2C%22localized_value%22%3Afalse%2C%22language_code%22%3A%22en%22%2C%22str_payment_mode_level_1%22%3Anull%2C%22str_payment_status%22%3A%22Completed%22%2C%22sales_rep%22%3Anull%2C%22str_tenant_ids%22%3A%22123%22%7D

You can now send a GET request to this URL to receive the report data.

API Endpoint#

Authentication#

Parameter Details#

1. Path Parameters#

2. Query Parameters#

Constructing the rpt_fltr_payload#

Common Payload Parameters#

Additional Parameters#

Available Reports#

Example Request#