/v1/report/query

Overview

This request calls the WellnessLiving reporting endpoint to execute a member/report query for business BID 49197 in region 2 in the UAT environment. It runs a server-side report definition (cid_report) with pagination, sort options, and a JSON-encoded filter, returning a dynamic column schema and result rows.

Method: POST

URL: https://uat-api.wellnessliving.io/v1/report/query?id_region=2&k_business=49197

Use case: Retrieve tabular report data (e.g., member details, addresses, demographics, and custom fields) for analytics, exports, or dashboards.

Required Headers

Content-Type: application/json

Any required authentication (e.g., bearer token) must be provided by the collection or environment (not set directly in this request description).

Request Body

Body is sent as raw JSON. The key fields are:

k_business (string | number)

Business key/BID to run the report for.

Must match the business in the URL query (49197 in this collection).

cid_report (number)

Internal report configuration ID (e.g. 689).

Determines which report template, columns, and logic are executed.

i_limit (number)

Maximum number of rows to return in this page.

Used for pagination (e.g. 50).

i_offset (number)

Zero-based offset of the first row to return.

Used with i_limit to page through larger result sets.

is_backend (0 | 1)

Indicates that the request is coming from the back office / internal system.

Typically 1 in this collection context.

is_refresh (0 | 1)

Controls whether to force a refresh of cached report data.

0 → use existing/cached data where possible.

1 → force recalculation/refresh.

s_sort (string)

Sort key indicating which column to order results by (e.g. "uid").

The exact value must be valid for the configured report.

json_filter (string; JSON-encoded object)

A string containing a JSON object that defines filter criteria for the report.

Example structure (simplified):

{
  "o_business_contract": [],
  "o_client_churn": [],
  "o_location": [],
  ...
}

Use this to restrict the data set by fields such as membership, location, custom fields, etc.

Note: json_filter itself is a string field; its value must be valid JSON when parsed on the server side.

Successful Response (200)

A successful 200 OK response returns a JSON object that includes dynamic report metadata and result rows. At a high level:

a_dynamic

Map of dynamic column definitions keyed by field name (e.g. "field-general-2", "field-custom-100000078810").

Each entry describes a column:

text_title / text_title_export – display/export labels (e.g. "First Name", "Address", "Date of Birth").

a_type – data type information (e.g. string, bool).

is_dynamic, is_export, is_show, is_store, is_order – flags controlling visibility, ordering, and export behavior.

Optional nested a_cell definitions for composite fields (e.g. city/region/country for an address, date parts, etc.).

Other top-level fields (not fully shown in the truncated sample) typically include:

Row data array that aligns with the dynamic column definitions.

Additional metadata for pagination, totals, or formatting.

In this collection context, common dynamic fields represent member demographics and contact information, including:

First/Last Name

Username and Client/Member ID

Address, City, Region, Country, ZIP/Postal Code

Date of Birth, Gender

Location and other custom fields (e.g. checkboxes, dropdowns, radio buttons).

Use the a_dynamic map to understand the available columns and drive client-side rendering, exports, or downstream processing of the report output.

Overview#

Required Headers#

Request Body#

Successful Response (200)#

Request

Responses

Overview

Required Headers

Request Body

Successful Response (200)