获取质量报告概览

功能介绍

获取质量报告概览。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/quality/report/overview

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参见项目ID和账号ID。

表2 Query参数
参数	是否必选	参数类型	描述
quality_score_dimension	是	String	质量评分维度。
l1	否	String	主题域分组(业务报告有效)。
l2	否	String	主题域(业务报告有效)。
l3	否	String	业务对象(业务报告有效)。
data_connection_id	否	String	数据连接id(技术报告有效)。
database_name	否	String	数据库名称(技术报告有效)。
table_name	否	String	数据表名称(技术报告有效)。
start_timestamp	否	Long	开始时间戳。
end_timestamp	否	Long	结束时间戳。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
workspace	是	String	DataArts Studio工作空间ID，获取方法请参见实例ID和工作空间ID。
X-Auth-Token	是	String	IAM Token，Token获取请参见认证鉴权。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
score	Double	总分。
ranges	Array of ScoreRangeVO objects	区间列表及个数。

表5 ScoreRangeVO
参数	参数类型	描述
count	Integer	个数。
name	String	区间名。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DQC.0000表示请求处理成功。
error_msg	String	错误信息。

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DQC.0000表示请求处理成功。
error_msg	String	错误信息。

请求示例

GET /v2/0833a5737480d53b2f25c010dc1a7b88/quality/report/overview?data_connection_id=2d9dcb2076b34bbab1c675f070d6af9d&quality_score_dimension=technology

响应示例

状态码： 200

Success

{
  "score" : 56.75,
  "ranges" : [ {
    "count" : 9,
    "name" : "80-100"
  }, {
    "count" : 2,
    "name" : "60-80"
  }, {
    "count" : 2,
    "name" : "40-60"
  }, {
    "count" : 6,
    "name" : "0-20"
  } ]
}