Querying Compound Metrics

Function

This API is used to query compound metrics based on the name, creator, approver, status, modification time, and l3Id, and display the results on different pages.

URI

GET /v2/{project_id}/design/compound-metrics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Fuzzy query by name or code
create_by	No	String	Creator
approver	No	String	Approver
status	No	String	Business status Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
dimension_group	No	String	Parameters for querying dimension attributes based on the dimension group
atomic_index_id	No	Long	Parameters for querying dimension attributes based on the atomic metric ID
l3_id	No	Long	ID of business object l3
begin_time	No	String	Left boundary for a time filter. This parameter must be used together with end_time.
end_time	No	String	Right boundary for a time filter. This parameter must be used together with begin_time.
limit	No	Integer	Number of records to be queried, that is, Y records. The value ranges from 1 to 100. The default value is 50. Maximum: 100 Default: 50
offset	No	Integer	Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down. The default value is 0. Default: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Long	ID
name_en	String	Compound metric name in English Maximum: 200
name_ch	String	Compound metric name in Chinese Maximum: 200
description	String	Maximum: 600
dimension_group	String	Dimension group Default: 0
group_name	String	Dimension group name
group_code	String	Dimension group code
metric_ids	Array of integers	Metric IDs
metric_names	Array of strings	Metric names
cal_fn_ids	Array of integers	Referenced function ID
cal_exp	String	Calculation expression ${index_id} + ${index_id}
l1_id	Long	Subject area group ID
l2_id	String	Subject area ID
l3_id	Long	Business object ID
data_type	String	Data type
create_by	String	Creator
update_by	String	User who updated the compound metric
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
create_time	String	Creation time
update_time	String	Update time
approval_info	ApprovalVO object	Approval information
new_biz	BizVersionManageVO object	Business version management
monitor	MetricMonitorVO object	Metric monitoring information
l1	String	Chinese name of the subject area group
l2	String	Chinese name of the subject area
l3	String	Chinese name of the business object
summary_table_id	Long	Summary table ID

**Table 4** ApprovalVO
Parameter	Type	Description
id	Long	ID
tenant_id	String	tenant id
name_ch	String	Approval name in Chinese
name_en	String	Approval name in English
biz_id	Long	Business ID
biz_type	String	Business types Enumeration values: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC
biz_info	String	Business information
biz_info_obj	Object	Business information object
biz_version	Integer	Business version
biz_status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
approval_status	String	Approval statuses Enumeration values: DEVELOPING APPROVED REJECT WITHDREW
approval_type	String	Approval types Enumeration values: PUBLISH OFFLINE
submit_time	String	Submission time
create_by	String	Creator
l1	String	Subject area group
l2	String	Subject area
l3	String	Business object
approval_time	String	Approval time
approver	String	Approver
email	String	Approver email address
msg	String	Approval message
directory_path	String	Directory tree

**Table 5** BizVersionManageVO
Parameter	Type	Description
id	Long	ID information
biz_type	String	Business types Enumeration values: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC
biz_id	Long	Business ID
biz_info	String	Business object information
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
biz_version	Integer	Business version
create_time	String	Creation time
update_time	String	Update time

**Table 6** MetricMonitorVO
Parameter	Type	Description
id	Long	ID
other_metric_ids	Array of integers	IDs of other metrics
other_metric_names	Array of strings	Names of other metrics
expression	String	Alarm expression Maximum: 2000
metric_id	Long	Metric ID
front_configs	String	Frontend expression configuration, which is used for frontend data restoration
metric_type	String	Metric type Enumeration values: ATOMIC_INDEX DERIVATIVE_INDEX DIMENSION DIMENSION_ATTRIBUTE DIMENSION_HIERARCHIES CONDITION_GROUP TIME_CONDITION COMMON_CONDITION FACT_LOGIC_TABLE TABLE_MODEL DIMENSION_LOGIC_TABLE STANDARD_ELEMENT AGGREGATION_LOGIC_TABLE TAG CODE_TABLE TABLE_MODEL_ATTRIBUTE FACT_DIMENSION FACT_ATTRIBUTE FACT_MEASURE SUMMARY_DIMENSION_ATTRIBUTE SUMMARY_TIME DIMENSION_TABLE_ATTRIBUTE QUALITY_RULE BIZ_METRIC COMPOUND_METRIC INFO_ARCH DEGENERATE_DIMENSION TABLE_MODEL_LOGIC

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.000 which indicates that the request was successfully processed.
error_msg	String	Error message
data	Object	Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. The CompoundMetricVO array and the total number of compound metrics are returned.

{
  "id" : "1014222358430482432",
  "name_en" : "fuhe",
  "name_ch" : "fuhe",
  "description" : "",
  "dimension_group" : "873251932406448128",
  "group_name" : "Payment method",
  "group_code" : null,
  "metric_ids" : [ "873265905193426944" ],
  "metric_names" : null,
  "cal_fn_ids" : null,
  "cal_exp" : "${873265905193426944}",
  "l1_id" : "873232498044411904",
  "l2_id" : null,
  "l3_id" : null,
  "data_type" : "BIGINT",
  "create_by" : "abc",
  "update_by" : "abc",
  "status" : "DRAFT",
  "create_time" : "2022-08-30T17:17:34+08:00",
  "update_time" : "2022-08-30T17:17:34+08:00",
  "approval_info" : null,
  "new_biz" : null,
  "monitor" : null,
  "l1" : "City traffic",
  "l2" : null,
  "l3" : null,
  "summary_table_id" : null
}

Status Codes

Status Code	Description
200	The operation succeeds. The CompoundMetricVO array and the total number of compound metrics are returned.
400	BadRequest
401	Unauthorized
403	Forbidden