/v1/report/query

This endpoint allows the user to make a POST request to retrieve a report based on specified query parameters.

Request

Parameters:

id_region (integer): The ID of the region.

k_business (integer): The ID of the business.

Request Body

uid_actor (integer) - The unique identifier of the actor.

k_business (integer) - The identifier of the business.

cid_report (integer) - The identifier of the report.

i_limit (integer) - The limit on the number of results to be returned.

i_offset (integer) - The offset for paginating through the results.

is_backend (integer) - Indicates if the request is from the backend.

is_refresh (integer) - Indicates if the request is a refresh.

s_sort (string) - The sorting parameter for the results.

json_filter (string) - The JSON filter for customizing the query.

Response

Status: 200

Content-Type: application/json

The response object contains various fields and subfields with dynamic and export properties. The id_report_status field indicates the status of the report, and the text_error field provides any error message if applicable.

The response is a JSON object with the following structure:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "a_dynamic": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "a_cell": { "type": "array" },
          "a_customization_element": { "type": "array" },
          "a_type": { "type": "object" },
          "is_dynamic": { "type": "boolean" },
          "is_export": { "type": "boolean" },
          "is_hide_by_default": { "type": "boolean" },
          "is_hide_if_empty": { "type": "boolean" },
          "is_null": { "type": "boolean" },
          "is_order": { "type": "boolean" },
          "is_show": { "type": "boolean" },
          "is_store": { "type": "boolean" },
          "s_cast": { "type": ["string", "null"] },
          "s_class": { "type": ["string", "null"] },
          "s_class_css": { "type": "string" },
          "s_format": { "type": ["string", "null"] },
          "s_name": { "type": "string" },
          "s_sort": { "type": "string" },
          "s_type": { "type": ["string", "null"] },
          "text_title": { "type": ["string", "null"] },
          "text_title_export": { "type": ["string", "null"] },
          "text_title_info": { "type": ["string", "null"] }
        }
      }
    },
    "a_field": {
      "type": "array",
      "items": { "type": "string" }
    },
    "a_row": {
      "type": "array",
      "items": {
        "type": "array",
        "items": { "type": ["string", "number", "boolean", "null"] }
      }
    },
    "a_stale": { "type": "array" },
    "a_warning": { "type": "array" },
    "dtu_complete": { "type": "string", "format": "date-time" },
    "dtu_queue": { "type": "string", "format": "date-time" },
    "dtu_start": { "type": "string", "format": "date-time" },
    "i_cas_change": { "type": "integer" },
    "id_report_status": { "type": "integer" },
    "s_report": { "type": "string" },
    "text_error": { "type": "string" },
    "status": { "type": "string" },
    "k_log": { "type": "string" },
    "s_version": { "type": "string" },
    "__a_message": {
      "type": "array",
      "items": { "type": "string" }
    }
  },
  "required": ["a_dynamic", "a_field", "a_row", "status"]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

id_region

string

required

Example:

k_business

string

required

Example:

49197

Body Params application/json

uid_actor

integer

required

k_business

integer

required

cid_report

integer

required

i_limit

integer

required

i_offset

integer

required

is_backend

integer

required

is_refresh

integer

required

s_sort

string

required

json_filter

string

required

Example

{"uid_actor": 2976021, "k_business":49197,"cid_report":689,"i_limit":50,"i_offset":0,"is_backend":0,"is_refresh":0, "s_sort": "uid", "json_filter":"{\"o_business_contract\":[],\"o_client_churn_risk\":[],\"o_client_type\":[],\"o_date\":{\"dl_end\":\"2024-12-31\",\"dl_start\":\"2024-01-01\",\"id_report_date\":4},\"o_gender\":[],\"o_liability_waiver\":[],\"o_location_home\":[],\"o_login_list\":[],\"o_member_group\":[],\"o_member_status\":[3],\"o_member_subscribe\":[],\"o_promotion_special\":[],\"o_search\":\"\",\"o_search_template\":{\"is_dashboard\":0,\"k_search_template\":\"\"},\"o_user_app\":[]}"}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request#

Request Body#

Response#

Request

Request samples

Responses

Request

Request Body

Response