跳转至

指标多维归因分析查询校验

接口说明

本接口用于校验指标是否能够进行指标的归因分析,当结果范围为true时,可以进行指标归因,结果为false时,不能用于进行指标归因分析。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/metric/attribution/report/check

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

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式,用于设置身份认证方式 UID:使用 UID 进行身份认证TOKEN:使用 TOKEN 进行身份认证
auth-value String 32 UID或者TOKEN值,与auth-type 类型选择一致

公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

2.5 请求参数

参数 类型 是否必选 描述
analysisRange Map 查询范围

- current:当前分析日期

- comparison:对比分析日期
metric String 指标名称
dimensions List 分析维度名称列表支持任意字符,长度150字符以内
timeConstraint String 时间筛选器
filters List 筛选器
displayFilters List 结果筛选器:针对指标查询结果进行过滤,功能等同于 sql 中的 having
limit Integer 返回行数默认 200

响应参数

响应参数说明

参数 类型 是否必选 最大长度 描述
code String 32 接口响应码
message String 512 消息体
traceId String 128 traceId
data array 具体参数说明参见:4.2data 参数详情

data 参数说明

参数 类型 是否必选 最大长度 描述
result Boolean 布尔值 校验是否通过
errorMsg String 512 不通过原因

请求示例

{
    "analysisRange": {
        "current": "2024-05-11",
        "comparison": "2024-05-10"
    },
    "metric": "ordercount_3",
    "dimensions": [
        "order_id_2"
    ],
    "timeConstraint": {},
    "filters": [],
    "limit": 2
}

响应

{
    "data":
    {
        "result": true,
        "errorMsg": null
    },
    "success": true,
    "code": 200,
    "errorMsg": null,
    "traceId": "b6bbdc8f33f642de9a250e690238bdff.254.17067705870260001"
}