更新时间:2022-04-25 GMT+08:00
分享

查询效果指标

功能介绍

该接口用于查询推荐效果指标。

URI

GET /v1/{project_id}/query-indicators/{job_id}

参数说明请参见表1

表1 URI参数说明

名称

是否必选

类型

说明

project_id

String

项目编号,用于资源隔离。获取方法请参见获取项目ID

job_id

String

作业ID,用于区分各个作业。

请求消息

暂不涉及。

响应消息

响应参数请参见表2

表2 响应参数说明

参数名称

参数类型

说明

is_success

Boolean

请求是否成功。

indicator_values

Map[String,Map[String, Map[String, String]]]

查询到的效果指标,外层map的key表示服务名称,中间层表示流程名称,里层map的key表示时间戳,value表示对应的指标的值。

error_msg

String

请求失败时的错误信息,请求成功时无此字段。

error_code

String

请求失败时的错误码,请求成功时无此字段。

示例

  • 成功响应示例
    {
        "is_success": true,
        "indicator_values": {
            "service1": {
                "flowA": {
                    "clickUV": {
                        "1559318400": "0.000",
                        "1559404800": "12.000",
                        "1559491200": "0.000",
                        "1559577600": "45.000"
                    },
                    "indicator1": {
                        "1559318400": "12.000",
                        "1559404800": "0.000",
                        "1559491200": "5.000",
                        "1559577600": "0.000"
                    },
                    "indicator2": {
                        "1559318400": "1.000",
                        "1559404800": "0.000",
                        "1559491200": "3.000",
                        "1559577600": "0.000"
                    }
                }
            }
        }
    }
  • 失败响应示例
    { 
        "is_success": false, 
        "error_code": "res.xxxx", 
        "error_msg": "Failed to query indicators." 
    }

状态码

状态码请参见状态码

相关文档