获取被评估人关键指标结果

批量获取指定周期中被评估人的关键指标结果。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/performance/v2/metric_details/query
HTTP Method	POST
接口频率限制	20 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	performance:metric:write 管理关键指标数据 performance:metric:read 获取关键指标数据
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ - people_admin_id: 以people_admin_id来识别用户 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
semester_id	string	是	周期 ID，1 次只允许查询 1 个周期，semester_id 可通过【获取周期】接口获得 示例值："6992035450862224940"
reviewee_user_ids	string\[\]	是	被评估人 ID 列表，与入参 user_id_type 类型一致 示例值：["ou_3245842393d09e9428ad4655da6e30b3"] 数据校验规则： - 长度范围：1 ～ 50

请求体示例

{
    "semester_id": "6992035450862224940",
    "reviewee_user_ids": [
        "ou_3245842393d09e9428ad4655da6e30b3"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ semester_id	string	周期 ID，详情可查看：获取周期
└ reviewee_metrics	reviewee_metric\[\]	指标明细列表
└ reviewee_user_id	user	被评估人
└ open_id	string	用户的 open_id
└ user_id	string	用户的 user_id，与入参 user_id_type 类型一致
└ metric_template_id	string	指标模板 ID，详情可查看：获取指标模板列表
└ metric_details	metric_detail	指标详情
└ metric_id	string	指标 ID，详情可查看：获取指标列表
└ name	string	指标名称，指标在该明细数据中的名称
└ fields	metric_field_in_details\[\]	指标字段信息
└ field_id	string	指标字段 ID，详情可查看：获取指标字段列表
└ field_value	string	指标字段值
└ field_value_person	user	字段值，当字段为人员信息时有值
└ open_id	string	用户的 open_id
└ user_id	string	用户的 user_id，取值与user_id_type一致
└ dimension_id	string	指标维度 ID
└ dimension_name	i18n	指标维度名称
└ zh_cn	string	指标维度中文名称
└ en_us	string	指标维度英文名称
└ dimension_weight	string	指标维度权重，如果没有设置则返回为空，单位为百分比
└ add_from	string	指标添加来源 可选值有： - reviewee: 指标制定人添加 - admin: 管理员添加
└ is_from_library	boolean	指标是否引自指标库
└ reviewee_stage_statuses	reviewee_stage_status\[\]	指标对应的环节状态
└ stage_id	string	环节ID
└ stage_type	string	环节类型 可选值有： - kpi_metric_setting：指标制定环节 - kpi_result_recording：结果录入环节
└ stage_status	int	环节状态 可选值有： - 0：未开始 - 1：待提交 - 2：已逾期 - 3：确认中 - 4：被驳回 - 5：已完成

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "semester_id": "7291278856547794964",
        "reviewee_metrics": [
            {
                "reviewee_user_id": {
                    "open_id": "od-asd2dasdasd",
                    "user_id": "ou-ux987dsf6x"
                },
                "metric_template_id": "7294570803306168339",
                "metric_details": {
                    "metric_id": "7272581996315099155",
                    "name": "示例指标",
                    "fields": [
                        {
                            "field_id": "7296082067266207764",
                            "field_value": "90",
                            "field_value_person": {
                                "open_id": "od-asd2dasdasd",
                                "user_id": "ou-ux987dsf6x"
                            }
                        }
                    ],
                    "dimension_id": "7303895818346430484",
                    "dimension_name": {
                        "zh_cn": "维度一",
                        "en_us": "Dimension 1"
                    },
                    "dimension_weight": "90%",
                    "add_from": "admin",
                    "is_from_library": true
                },
                "reviewee_stage_statuses": [
                    {
                        "stage_id": "1",
                        "stage_type": "kpi_metric_setting",
                        "stage_status": 0
                    }
                ]
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1580101	internal error	服务内部异常，请根据实际报错信息定位或咨询技术支持
400	1580102	param is invalid	检查参数是否正确，例如类型，大小
400	1580105	invalid semester ID	周期 ID 不存在，请检查 semester_id 入参是否正确
400	1580901	tenant no licnese	租户无绩效席位，请联系租户管理员开通绩效席位

更多错误码信息，参见通用错误码。