Obtaining the Quality Report Trend
Function
This API is used to obtain the quality report trend.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/report/trend
| 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| quality_score_dimension | Yes | String | Quality scoring dimension. |
| l1 | No | String | Subject area group (valid for business reports). |
| l2 | No | String | Subject area (valid for business reports). |
| l3 | No | String | Business object (valid for business reports). |
| data_connection_id | No | String | Data connection ID (valid for technical reports). |
| database_name | No | String | Database name (valid for technical reports). |
| table_name | No | String | Data table name (valid for technical reports). |
| start_timestamp | No | Long | Start timestamp. |
| end_timestamp | No | Long | End timestamp. |
Request 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
| Parameter | Type | Description |
|---|---|---|
| trends | Array of ScoreTrendVO objects | ScoreTrendVO, which is the array of score change trends |
Status code: 400
| 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
| 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/trend?data_connection_id=2d9dcb2076b34bbab1c675f070d6af9d&quality_score_dimension=technology
Example Responses
Status code: 200
Success
{
"trends" : [ {
"score" : 57.63,
"timestamp" : "1669132800000"
}, {
"score" : 56.92,
"timestamp" : "1669219200000"
}, {
"score" : 60.27,
"timestamp" : "1669305600000"
}, {
"score" : 59.54,
"timestamp" : "1669392000000"
}, {
"score" : 65.07,
"timestamp" : "1669478400000"
}, {
"score" : 57.19,
"timestamp" : "1669564800000"
}, {
"score" : 56.75,
"timestamp" : "1669651200000"
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Success |
| 400 | BadRequest |
| 500 | INTERNAL SERVER ERROR |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
