/v1/report/data

Overview

Retrieves tabular report data for a specific business and region. This endpoint is typically used to power reporting views (e.g., client or membership lists) where each row represents an entity and columns are returned dynamically based on the selected report.

Authorization

Uses bearer-style auth via the TOKEN variable.

Ensure TOKEN is set (for example, in the active environment) before sending the request. It should contain a valid access token for the target UAT environment.

Query Parameters

id_region (number, required)

Region identifier used to scope the report data (e.g., data center or deployment region).

k_business (number, required)

Unique business identifier. Only report data for this business is returned.

id_report (number, required)

Identifier of the report definition to execute (e.g., “Client List”, “Login List”, or other configured reports).

Response (200 OK)

A successful response returns a JSON object with the main keys below:

status (string)

Overall result of the call. For successful calls this is typically "ok".

a_data (object)

a_row (array)

Collection of result rows for the requested report.

Each element contains:

a_data_api (object): Field values for the row (for example s_firstname, s_lastname, s_mail, s_name, a_member_group, url_photo, and other report-specific fields).

dt_since_local (object): Local date/time metadata for the row (e.g., dt_date).

Additional row-level fields such as s_note, uid, member, etc., depending on the report configuration.

a_total (object)

Aggregated metrics for the report, keyed by internal identifiers (e.g., i_login_type.\*).

Each entry typically includes:

is_prospect (boolean): Indicates whether the segment represents prospects.

s_title (string): Human-readable label (e.g., "Active Member", "Prospect").

s_value (number): Aggregate count or value for that segment.

Additional metadata fields such as k_log, s_version, and __a_message may also be present and are primarily used for internal logging, versioning, or additional localized messages related to the report.

Overview

Authorization

Query Parameters

Response (200 OK)

Request

Responses

/v1/report/data

Overview#

Authorization#

Query Parameters#

Response (200 OK)#

Request

Responses

Overview

Authorization

Query Parameters

Response (200 OK)