根据ID查询指标视图详情

接口说明

本接口适用于根据 ID 查询指标视图

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/analysisview/query

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

请求参数

公共请求参数(HEADERS)

参数	类型	是否必选	描述
tenant-id	String	是	租户ID，用于指标查询内容所在的租户
auth-type	String	是	认证方式。支持 UID、TOKEN、ACCOUNT、APIKEY
auth-value	String	是	与 auth-type 对应的认证值

公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成，在 API 集成界面获取；auth-value 请按 auth-type 填写对应认证值。

4.5 请求参数

参数	类型	是否必选	最大长度	描述
id	int	是		指标视图ID

响应参数

响应参数说明

参数	类型	是否必选	最大长度	描述
code	String	是	32	接口响应码
message	String	是	512	消息体
traceId	String	是	128	traceId
data	Array[Object]	是		查询结果。具体参数详情参见：4.2data 参数详情

data 参数说明

参数	类型	是否必选	最大长度	描述
id	Long	是		指标视图id
viewName	String	是	50	指标视图名称
description	String	否	300	指标视图描述
displayName	String	是		指标视图展示名
metrics	Array[String]	是		指标列表
dimensions	Array[String]	否		维度列表
filters	Array[String]	否		筛选器
time_constraint	String	否		日期范围
orders	Array[String]	否		查询的排序规则。引用的维度需要包含在“dimensions”参数中。

请求示例

http://127.0.0.1/anymetrics/api/v1/analysisview/query?id=1

响应示例

{
    "code": "200",
    "message": "请求成功",
    "traceId": "fdde6861bd554805998343f9ff2dcd70.292.16857691758642861",
    "data": [
        {
            "id": 1,
            "viewName": "OrderAnalysisView2",
            "description": "订单指标视图2",
            "metrics": [
                "orderCount"
            ],
            "dimensions": [
                "stories/category"
            ],
            "filters": [
                {
                    "name": "stories/isDraft",
                    "operator": "=",
                    "values": [
                        "No"
                    ]
                }
            ],
            "time_constraint":"BETWEEN 2023-01-01 AND  2023-01-10",
            "orders": [
                {
                    "stories/time": "asc"
                },
                {
                    "stories/count": "desc"
                }
            ]
        }
    ]
}