飞书开放平台 Server API 文档

主题

获取指标模板列表 ​

批量获取指标模板的信息。

请求 ​

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

请求头 ​

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

查询参数 ​

名称类型必填描述
user_id_typestring否用户 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
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
page_sizeint否分页大小
示例值：30
默认值：20
数据校验规则：
- 取值范围：1 ～ 50

请求体 ​

名称类型必填描述
metrics_template_idsstring\[\]否指标模板 ID 列表，填写时获取指定的指标模版
示例值：["7360956875099078676"]
数据校验规则：
- 长度范围：0 ～ 50
statusstring否指标模版状态
示例值："to_be_configured"
可选值有：
- to_be_configured: 待完成配置 - to_be_activated: 待启用 - enabled: 已启用 - disabled: 已停用

注：参数之间是「与」关系，都不传时分页返回所有指标模版信息。

请求体示例 ​

json
{
    "metrics_template_ids": [
        "7360956875099078676"
    ],
    "status": "to_be_configured"
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ itemsmetric_template\[\]指标模板信息
    └ idstring指标模板 ID
    └ namei18n模版名称
      └ zh_cnstring模版中文名称
      └ en_usstring模版英文名称
    └ descriptioni18n模板描述
      └ zh_cnstring模板中文描述
      └ en_usstring模板英文描述
    └ statusstring模版状态
可选值有：
- to_be_configured: 待完成配置 - to_be_activated: 待启用 - enabled: 已启用 - disabled: 已停用
    └ is_set_by_groupboolean模版是否分人群设置指标
    └ total_metric_score_methodstring模版指标总分计算方式
可选值有：
- review_manually: 手动评估 - sum: 加和计算 - weight: 加权计算 - formula: 自定义公式
    └ metric_weight_methodstring指标权重计算方式
可选值有：
- sum_of_metric_weights_for_each_dimension_equals_1: 每个维度内的指标权重之和等于 100% - total_sum_of_all_metric_weight_equals_1: 全部指标权重之和等于 100%
    └ metric_dimensionsmetric_dimension\[\]指标维度列表
      └ group_idstring所属人群分组 ID，模板分人群设置指标时，指标维度按照人群分组；未分人群设置时该值为空
      └ metric_dimension_idstring指标维度 ID
      └ namei18n指标维度名称
        └ zh_cnstring指标维度中文名称
        └ en_usstring指标维度英文名称
      └ evaluation_rule_id_for_each_metricstring指标评估规则 ID
      └ dimension_weightstring维度权重，如果没有设置则返回为空（和设置为 0 进行区分），单位为百分比
      └ descriptioni18n维度描述
        └ zh_cnstring中文
        └ en_usstring英文
      └ review_rule_optionint各指标的评估规则
可选值有：
- 0: 使用相同规则 - 1: 使用不同规则
      └ custom_metric_configcustom_metric_config被评估人添加指标的设置
        └ default_formula_idstring非指标库指标的评分方式（手动评分是 0；评分公式是具体的公式 ID）
        └ least_metrics_sizeint最少需添加的指标数量
        └ add_metric_optionsint\[\]添加指标的方式
可选值有：
- 1: 可选用指标库的指标 - 2: 可选用自定义的指标
    └ metricsmetric_in_template\[\]指标列表
      └ group_idstring所属人群分组 ID，模板分人群设置指标时，指标维度按照人群分组；未分人群设置时该值为空
      └ metric_idstring指标 ID（备注：指标的统一标识 ID。如果模板存在分组，需要+分组 ID 才能标识到指标模板唯一的指标）
      └ namestring指标名称（指标在当前模板中的名称）
      └ type_idstring指标类型 ID
      └ fieldsmetric_field_in_template\[\]指标字段信息
        └ idstring指标字段 ID，详情可查看：获取指标字段列表
        └ input_settingstring字段填写方式设置
可选值有：
- admin: 管理员统一配置 - data_source_inputter: 数据源录入人填写 - reviewee: 指标制定人填写
        └ filed_valuestring字段值
        └ field_value_personuser字段值，当字段为人员信息的时候有值
          └ open_idstring用户的 open_id
          └ user_idstring用户的 user_id，取值与user_id_type一致
      └ is_from_libraryboolean指标是否引自指标库
      └ scoring_setting_typestring评分设置类型
可选值有：
- socre_manually: 手动评分 - score_by_formula: 公式评分
      └ data_source_inputtersuser\[\]数据源录入人
        └ open_idstring用户的 open_id
        └ user_idstring用户的 user_id，与入参 user_id_type 类型一致
      └ metric_dimension_idstring指标维度 ID
      └ review_rule_configmetric_review_rule_config评估规则
        └ maxstring最高分
        └ minstring最低分
    └ groupsmetric_group\[\]人群分组
      └ group_idstring人群分组 ID
      └ namestring人群分组名称
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "7296488199415660563",
                "name": {
                    "zh_cn": "体验",
                    "en_us": "Interactive experience"
                },
                "description": {
                    "zh_cn": "体验",
                    "en_us": "Interactive experience"
                },
                "status": "to_be_configured",
                "is_set_by_group": true,
                "total_metric_score_method": "weight",
                "metric_weight_method": "sum_of_metric_weights_for_each_dimension_equals_100",
                "metric_dimensions": [
                    {
                        "group_id": "7296753366268215316",
                        "metric_dimension_id": "7296753366268215316",
                        "name": {
                            "zh_cn": "体验",
                            "en_us": "Interactive experience"
                        },
                        "evaluation_rule_id_for_each_metric": "7296701873237786643",
                        "dimension_weight": "90",
                        "description": {
                            "zh_cn": "维度描述",
                            "en_us": "Dimension description"
                        },
                        "review_rule_option": 0,
                        "custom_metric_config": {
                            "default_formula_id": "7296701873237786643",
                            "least_metrics_size": 1,
                            "add_metric_options": [
                                1,
                                2
                            ]
                        }
                    }
                ],
                "metrics": [
                    {
                        "group_id": "7272581996315099155",
                        "metric_id": "7272581996315099155",
                        "name": "销售额",
                        "type_id": "7272581996315099155",
                        "fields": [
                            {
                                "id": "7272581996315099155",
                                "input_setting": "admin",
                                "filed_value": "100",
                                "field_value_person": {
                                    "open_id": "od-asd2dasdasd",
                                    "user_id": "ou-ux987dsf6x"
                                }
                            }
                        ],
                        "is_from_library": true,
                        "scoring_setting_type": "score_by_formula",
                        "data_source_inputters": [
                            {
                                "open_id": "od-asd2dasdasd",
                                "user_id": "ou-ux987dsf6x"
                            }
                        ],
                        "metric_dimension_id": "7272581996315099155",
                        "review_rule_config": {
                            "max": "10",
                            "min": "0"
                        }
                    }
                ],
                "groups": [
                    {
                        "group_id": "7296466589195436051",
                        "name": "分组 1"
                    }
                ]
            }
        ],
        "has_more": true,
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
5001580101internal error服务内部异常，请根据实际报错信息定位或咨询技术支持
4001580102param is invalid检查参数是否正确，例如类型，大小
4001580107page token invalidpage token 不存在，请检查 page_token 入参是否正确
4001580108page token expiredpage token 已过期，请重新获取 page_token
4001580901tenant no licnese租户无绩效席位，请联系租户管理员开通绩效席位

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

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

本镜像仅供学习与查阅，文档版权归飞书所有