Obtaining Standard Coverage Statistics

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to obtain standard coverage statistics.

URI

GET /v2/{project_id}/design/definitions/statistic/{id}

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
biz_type	No	String	Business types

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
all_col_num	Long	Total number of fields
col_num	Long	Number of associated standard fields
coverage	Double	Standard coverage rate
details	Array of AllTableVO objects	Overview table

**Table 4** AllTableVO
Parameter	Type	Description
id	Long	l1 ID
name	String	L1 name
tb_logic_guid	String	GUID of the logical entity corresponding to the published table
quality_id	String	Quality ID
reversed	Boolean	Whether the table is reversed Default: false
partition_conf	String	Partition expression
dirty_out_switch	Boolean	Whether to export dirty data Default: false
dirty_out_database	String	Database to which dirty data will be exported
dirty_out_prefix	String	Prefix of an abnormal table
dirty_out_suffix	String	Suffix of an abnormal table
tb_guid	String	GUID of the physical table corresponding to the published table
code	String	Code
create_by	String	Creator
tenant_id	String	Tenant ID
description	String	Description Maximum: 200
status	String	Business statuses Enumeration values: DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT
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
create_time	String	Creation time
update_time	String	Update time
db_name	String	Database name
dw_type	String	Data connection type
queue_name	String	Queue required for a DLI data connection to execute SQL statements. This parameter is mandatory for DLI data connections.
schema	String	Schema, which is required for DWS
l1	String	Subject area group
l2	String	Subject area
l3	String	Business object
l1_id	Long	Subject area group ID
l2_id	String	Subject area ID
l3_id	Long	Business object ID
new_biz	BizVersionManageVO object	Business version management
physical_table	String	Table creation status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
technical_asset	String	Technical asset synchronization status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
business_asset	String	Logical asset synchronization status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
meta_data_link	String	Asset association status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
data_quality	String	Quality job status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
dlf_task	String	Data development job status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
materialization	String	Storage status of the lookup table value Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
publish_to_dlm	String	DLM API generation status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
summary_status	String	Overall synchronization status Enumeration values: NO_NEED CREATE_SUCCESS CREATE_FAILED UPDATE_SUCCESS UPDATE_FAILED SUMMARY_SUCCESS SUMMARY_FAILED RUNNING OFFLINE
standard_count	Long	Number of standards
alias	String	Alias
api_id	String	Summary table API ID
workspace_id	String	Workspace ID
workspace_name	String	Workspace name

**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

Status code: 400

**Table 6** 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 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: 403

**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

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. StatisticStandardCoverageVO is returned.

{
  "all_col_num" : "182",
  "col_num" : "1",
  "coverage" : 0.005494505494505495,
  "details" : [ {
    "id" : "873249129940361216",
    "name" : "Standard trip data",
    "tb_logic_guid" : "3aaca75c-8399-423d-aedb-2e09db2b7f79",
    "quality_id" : "873249649983729665",
    "reversed" : null,
    "partition_conf" : null,
    "dirty_out_switch" : false,
    "dirty_out_database" : "",
    "dirty_out_prefix" : "",
    "dirty_out_suffix" : "",
    "tb_guid" : "51e5cfbe-3f6f-4caf-a216-b35eeffb0f56",
    "code" : "dwi_taxi_trip_data",
    "create_by" : "abc",
    "tenant_id" : "0cf68da0ba80f2962ff7c01ba8c0b7f7-workspace-f7eee36e67e541a59679f9b1b7f4eab0",
    "description" : "None",
    "status" : "PUBLISHED",
    "biz_type" : "TABLE_MODEL",
    "create_time" : "2021-08-06T17:00:17+08:00",
    "update_time" : "2022-08-23T19:25:54+08:00",
    "db_name" : "demo_dwi_db",
    "dw_type" : "DLI",
    "queue_name" : null,
    "schema" : "",
    "l1" : null,
    "l2" : null,
    "l3" : null,
    "l1_id" : null,
    "l2_id" : null,
    "l3_id" : "873233352591908864",
    "new_biz" : null,
    "physical_table" : "CREATE_SUCCESS",
    "technical_asset" : "UPDATE_SUCCESS",
    "business_asset" : "UPDATE_SUCCESS",
    "meta_data_link" : "UPDATE_SUCCESS",
    "data_quality" : "UPDATE_SUCCESS",
    "dlf_task" : "NO_NEED",
    "materialization" : null,
    "publish_to_dlm" : null,
    "summary_status" : "SUMMARY_SUCCESS",
    "standard_count" : "1",
    "alias" : null,
    "api_id" : "0",
    "workspace_id" : "f7eee36e67e541a59679f9b1b7f4eab0",
    "workspace_name" : "taxi-demo"
  } ]
}