数据开发治理平台 WeData API

一、基本信息

·API 英文名称：QueryMetric

·超时时间：30000ms

二、调用方式

该接口可通过云 API 接口调用，以 Java API 调用方式举例说明。

三、请求参数

参数名称	类型	描述	数组	必填	示例
Action	string	公共参数，本接口取值：QueryMetric。	否	是	QueryMetric
Version	string	公共参数，本接口取值：2021-08-20。	否	是	2021-08-20
Region	string	公共参数，详见产品支持的地域列表	否	是	ap-beijing
BelongProjectId	string	所属项目	否	是	–
DataReq	复杂类型	指标详细信息	否	是	–
SyncFlag	bool	是否同步查询	否	否	true
QueryId	string	异步请求场景下用该 ID 再次调用当前接口即可查询异步结果。	否	否	–

DataReq 类型

参数名称	类型	描述	数组	必填	示例
TimeOutput	复杂类型	时间字段	否	否	–
Metrics	string	指标名	是	否	–
Dimensions	string	指标维度	是	否	–
Limit	int64	查询数量	否	否	–
TimeStart	string	查询数据开始时间	否	否	–
TimeEnd	string	查询数据结束时间，不填写默认为请求发起时间	否	否	–
Wheres	string	添加对维度的过滤条件，格式为 Dimension(Cust_Type) = "VIP"	是	否	–
OrderBys	复杂类型	排序信息	是	否	–

TimeOutput 类型

参数名称	类型	描述	数组	必填	示例
Grain	string	输出时间单位：day, week, month, year	否	否	day

OrderBys 类型

参数名称	类型	描述	数组	必填	示例
ItemName	string	参与排序的维度名或指标名，输出时间名为 TimeOutput	否	否	–
Desc	bool	顺序	否	否	–

四、输出参数

参数名称	类型	描述
Data	复杂类型	查询结果

Data 类型

参数名称	类型	描述
QueryId	string	异步请求场景下用该 ID 再次调用当前接口即可查询异步结果。
Status	string	执行状态
ErrorMsg	string	错误消息
Data	复杂类型	详细结果

Data 类型

参数名称	类型	描述
Columns	复杂类型	列信息
Rows	复杂类型	指标信息

Columns 类型

参数名称	类型	描述
Name	string	查询设置的列名
Type	string	列类型

Rows 类型

参数名称	类型	描述
DetailInfo	复杂类型	rows 详细信息

DetailInfo 类型

参数名称	类型	描述
Value	string	指标值

五、请求示例

{ "BelongProjectId": "2800237293794955264", "DataReq": { "TimeOutput": { "Grain": "DAY" }, "Metrics": [ "uniTestGrain" ], "Dimensions": [ "account_no" ], "Limit": 100, "TimeStart": "2025-10-29T22:52:48", "TimeEnd": "2025-11-28T22:52:48", "Wheres": [ "Dimension(Cust_Type) = \\"VIP\\"" ], "OrderBys": [ { "ItemName": "account_no", "Desc": true } ] }, "SyncFlag": true}

六、响应示例

{ "Response": { "RequestId": "uni-debug-0521-1", "Data": { "QueryId": "f30fcf16-d4cd-4f41-997a-a296a60f9f96-1315051789", "Status": "COMPLETED", "ErrorMsg": null, "Data": { "Columns": [ { "Name": "timeOutput__year", "Type": null }, { "Name": "user_id", "Type": null }, { "Name": "0523metrict1", "Type": null } ], "Rows": [ { "DetailInfo": [ { "Value": "2025-01-01" }, { "Value": "U9770" }, { "Value": "1" } ] }, { "DetailInfo": [ { "Value": "2025-01-01" }, { "Value": "U1139" }, { "Value": "1" } ] }, { "DetailInfo": [ { "Value": "2025-01-01" }, { "Value": "U1115" }, { "Value": "1" } ] } ] } } }}