Skip to content

获取评估项列表

批量获取评估项信息,如评估项名称、评估项类型、评估项等级配置等信息。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/performance/v2/indicators/query
HTTP MethodPOST
接口频率限制10 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可performance:performance 管理绩效数据 performance:performance:readonly 查看绩效数据 performance:review_template:read 获取评估配置信息

请求头

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

查询参数

名称类型必填描述
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
page_sizeint分页大小
示例值:30
默认值20
数据校验规则
- 取值范围:050

请求体

名称类型必填描述
indicator_idsstring\[\]评估项 ID 列表,填写时获取指定的评估项,不填时返回所有评估项
示例值:["7343513161666707459"]
数据校验规则
- 长度范围:050

请求体示例

json
{
    "indicator_ids": [
        "7343513161666707459"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ indicatorsindicator\[\]评估项列表
    └ idstring评估项 ID
    └ namei18n评估项名称
      └ zh_cnstring评估项中文名称
      └ en_usstring评估项英文名称
    └ typestring评估项类型
可选值有
- general_review_item: 常规评估项 - review_item_based_on_key_metric: 关键指标评估项 - okr_review_item: OKR 评估项 - plus: 加分项 - minus: 减分项
    └ optionsindicator_option\[\]评估项等级列表
      └ idstring评估项等级 ID
      └ namei18n评估项等级名称
        └ zh_cnstring评估项等级中文名称
        └ en_usstring评估项等级英文名称
      └ lablestring评估项等级代号
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "indicators": [
            {
                "id": "7343513161666707459",
                "name": {
                    "zh_cn": "完成度",
                    "en_us": "Completeness"
                },
                "type": "plus",
                "options": [
                    {
                        "id": "7343513161666707459",
                        "name": {
                            "zh_cn": "等级 1",
                            "en_us": "Rank 1"
                        },
                        "lable": "qwerty"
                    }
                ]
            }
        ],
        "has_more": true,
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
    }
}

错误码

HTTP状态码错误码描述排查建议
4001580102param is invalid检查参数是否正确,例如类型,大小
5001580101internal error请根据实际报错信息定位或咨询技术支持

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理