Help Center/ DataArts Studio/ API Reference/ DataArts Quality APIs/ Quality Reports/ Obtaining the Business Report Data
Updated on 2025-11-17 GMT+08:00
View PDF

Obtaining the Business Report Data

Function

This API is used to obtain a business report.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/quality/report/business/scores

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

table_name

No

String

Specifies the name of the table.

l1

No

String

Subject area group.

l2

No

String

Subject area.

l3

No

String

Business object.

l1_score_order

No

String

Sorting order for subject area groups. Value 0 indicates the ascending order, and value 1 indicates the descending order. This order is mutually exclusive with other sorting conditions.

l2_score_order

No

String

Sorting order for subject areas. Value 0 indicates the ascending order, and value 1 indicates the descending order. This order is mutually exclusive with other sorting conditions.

l3_score_order

No

String

Sorting order for business objects. Value 0 indicates the ascending order, and value 1 indicates the descending order. This order is mutually exclusive with other sorting conditions.

table_score_order

No

String

Sorting order for data table scores. Value 0 indicates the ascending order, and value 1 indicates the descending order. This order is mutually exclusive with other sorting conditions.

start_timestamp

No

Long

Start timestamp.

end_timestamp

No

Long

End timestamp.

limit

No

Long

Number of records on each page. The value range is [0,100].

offset

No

Long

Pagination offset. The minimum value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

DataArts Studio workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Auth-Token

Yes

String

IAM token. For details about how to obtain the token, see Authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Number of data records

scores

Array of BusinessScoreVO objects

Returned BusinessScoreVO
Table 5 BusinessScoreVO

Parameter

Type

Description

id

String

Score ID

l1

String

Subject area group

l2

String

Subject area

l3

String

Business object

table_name

String

Table object name in the format of Data connection.Database.Schema table/Table.

l1_score

Double

Subject area group score

l2_score

Double

Subject area score

l3_score

Double

Business object score

table_score

Double

Table score

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

Example Requests

GET /v2/0833a5737480d53b2f25c010dc1a7b88/quality/report/business/scores

Example Responses

Status code: 200

Success

{
  "count" : 1,
  "scores" : [ {
    "id" : "1047319323363946496",
    "l1" : "test",
    "l2" : null,
    "l3" : null,
    "table_name" : "2d9dcb2076b34bbab1c675f070d6af9d.postgres.public.test",
    "l1_score" : 83.33,
    "l2_score" : null,
    "l3_score" : null,
    "table_score" : 83.33
  } ]
}

Status Codes

Status Code

Description

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR
Parent Topic: Quality Reports