# 指标设置查询接口
# 人员/部门指标配置查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/kpi/v1/queryKpiConfig/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
无 |
响应示例:
[
{
"id":"8953082409304430269",
"name": "指定商品",
"describe": "销售人员提交的有效订单中,商品的销售金额,单位:元",
"create_time": "2017-12-05 13:58:18",
"info_name": "订单金额(分销版)",
"info_code": "dms_order_pd_amount",
"assignList": [{
"assign_id": "8373727014019352452",
"assign_code": "code1",
"assign_name": "【code1】商品1【500ml】"
}]
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 指标id |
name | VARCHAR(200) | 指标名称 |
describe | VARCHAR(200) | 指标描述信息 |
create_time | VARCHAR(200) | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
info_name | VARCHAR(200) | 指标种类名称 |
info_code | VARCHAR(200) | 指标种类code |
assignList | list | 分配列表 |
assignList.assign_id | VARCHAR(32) | 维度id。指定维度时显示此字段 |
assignList.assign_code | VARCHAR(200) | 维度code。指定维度时显示此字段 |
assignList.assign_name | VARCHAR(200) | 维度描述。指定维度时显示此字段 |
# 客户指标配置查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/kpi/v1/queryCusKpiConfig/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
无 |
响应示例:
[
{
"id":"8953082409304430269",
"type":"1",
"name": "指定商品",
"describe": "销售人员提交的有效订单中,商品的销售金额,单位:元",
"create_time": "2017-12-05 13:58:18",
"info_name": "订单金额(分销版)",
"info_code": "dms_order_pd_amount",
"assignList": [{
"assign_id": "8373727014019352452",
"assign_code": "code1",
"assign_name": "【code1】商品1【500ml】"
}]
}
]
参数说明:
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 指标id |
name | VARCHAR(200) | 指标名称 |
type | VARCHAR(32) | 指标类型。1:为客户指标,2:为经销商指标,3:为终端指标 |
describe | VARCHAR(200) | 指标描述信息 |
create_time | VARCHAR(200) | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
info_name | VARCHAR(200) | 指标种类名称 |
info_code | VARCHAR(200) | 指标种类code |
assignList | list | 分配列表 |
assignList.assign_id | VARCHAR(32) | 维度id。指定维度时显示此字段 |
assignList.assign_code | VARCHAR(200) | 维度code。指定维度时显示此字段 |
assignList.assign_name | VARCHAR(200) | 维度描述。指定维度时显示此字段 |
# 人员月目标查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/kpi/v1/queryEmpMonthKpiSetting/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
setting_id | VARCHAR(32) | 是 | 指标id |
emp_id | VARCHAR(32) | 否 | 人员id |
dimension_id | VARCHAR(32) | 否 | 维度id |
pd_id | VARCHAR(32) | 否 | 商品id |
year | VARCHAR(4) | 否 | 年 |
month | VARCHAR(2) | 否 | 月 |
quarter | VARCHAR(1) | 否 | 季度 |
page | VARCHAR(10) | 否 | 数据页码。字段不填默认为1 |
rows | VARCHAR(10) | 否 | 每页数据显示条数。字段不填默认为值1000,设置范围为1~1000 |
参数说明:
[{
"id": "6404841350757337303",
"kpi_value": "213.00",
"emp_id": "6522836289768729779",
"pd_code": "code1",
"creator_id": "6802790356603352633",
"pd_name": "【code1】商品1【500ml】",
"pd_id": "8373727014019352452",
"emp_name": "人员1",
"create_time": "2018-06-30 16:41:29",
"month": "7",
"creator_name": "人员1",
"year": "2018",
"setting_id": "8953082409304430269",
"quarter": "3",
"setting_name": "指定商品",
"dimension_type":"1",
"dimension_id":"7705423564150216819",
"dimension_code":"CODE",
"dimension_name":"维度描述"
}]
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 人员月目标数据id |
setting_id | VARCHAR(32) | 指标id |
setting_name | VARCHAR(200) | 指标名称 |
creator_id | VARCHAR(32) | 创建人id |
creator_name | VARCHAR(200) | 创建人名称 |
create_time | VARCHAR(200) | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
emp_id | VARCHAR(32) | 被设置目标的人员id |
emp_name | VARCHAR(200) | 被设置目标的人员名称 |
dimension_type | VARCHAR(32) | 维度类型。1:商品,2:商品类型,3:商品品牌,4:拜访任务。指定维度时显示此字段 |
dimension_id | VARCHAR(32) | 维度id。指定维度时显示此字段 |
dimension_code | VARCHAR(32) | 维度code。指定维度时显示此字段 |
dimension_name | VARCHAR(32) | 维度描述。指定维度时显示此字段 |
pd_id | VARCHAR(32) | 商品id。指定商品时显示此字段 |
pd_code | VARCHAR(200) | 商品code。指定商品时显示此字段 |
pd_name | VARCHAR(200) | 商品描述。指定商品时显示此字段 |
year | VARCHAR(4) | 年 |
month | VARCHAR(2) | 月 |
quarter | VARCHAR(1) | 季度 |
kpi_value | numeric(12,2) | 目标值 |
# 部门月目标查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/kpi/v1/queryDeptMonthKpiSetting/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
setting_id | VARCHAR(32) | 是 | 指标id |
dept_id | VARCHAR(32) | 否 | 部门id |
dimension_id | VARCHAR(32) | 否 | 维度id |
year | VARCHAR(4) | 否 | 年 |
month | VARCHAR(2) | 否 | 月 |
quarter | VARCHAR(1) | 否 | 季度 |
page | VARCHAR(10) | 否 | 数据页码,字段不填默认为1 |
rows | VARCHAR(10) | 否 | 每页数据显示条数。字段不填默认为1000,设置范围为1~1000 |
参数说明:
[{
"id": "6404841350757337303",
"setting_id": "8953082409304430269",
"setting_name": "指定商品",
"creator_id": "6802790356603352633",
"creator_name": "人员1",
"create_time": "2018-06-30 16:41:29",
"dept_id": "6522836289768729779",
"dept_name": "部门1",
"emp_id":"5547554478618247667",
"emp_name":"人员1",
"emp_status":"2",
"dimension_type":"1",
"dimension_id":"7705423564150216819",
"dimension_code":"CODE",
"dimension_name":"维度描述",
"year": "2018",
"month": "7",
"quarter": "3",
"kpi_value": "213.00"
}]
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 部门月目标数据id |
setting_id | VARCHAR(32) | 指标id |
setting_name | VARCHAR(200) | 指标名称 |
creator_id | VARCHAR(32) | 创建人id |
creator_name | VARCHAR(200) | 创建人名称 |
create_time | VARCHAR(200) | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
dept_id | VARCHAR(32) | 被设置目标的部门id |
dept_name | VARCHAR(200) | 被设置目标的部门名称 |
emp_id | VARCHAR(32) | 被设置目标的人员id |
emp_name | VARCHAR(200) | 被设置目标的人员名称 |
emp_status | VARCHAR(200) | 被设置目标的人员状态。1:正常,2:停用,0:删除 |
dimension_type | VARCHAR(32) | 维度类型。1:为商品,2:为商品类型,3:为商品品牌,4:为拜访任务。指定维度时显示此字段 |
dimension_id | VARCHAR(32) | 维度id。指定维度时显示此字段 |
dimension_code | VARCHAR(32) | 维度code。指定维度时显示此字段 |
dimension_name | VARCHAR(32) | 维度描述。指定维度时显示此字段 |
year | VARCHAR(4) | 年 |
month | VARCHAR(2) | 月 |
quarter | VARCHAR(1) | 季度 |
kpi_value | numeric(12,2) | 目标值 |
# 客户月目标查询
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/kpi/v1/queryCusMonthKpiSetting/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
setting_id | VARCHAR(32) | 是 | 指标id |
customer_id | VARCHAR(32) | 否 | 客户id |
dimension_id | VARCHAR(32) | 否 | 维度id |
year | VARCHAR(4) | 否 | 年 |
month | VARCHAR(2) | 否 | 月 |
quarter | VARCHAR(1) | 否 | 季度 |
page | VARCHAR(10) | 否 | 数据页码,字段不填默认为1 |
rows | VARCHAR(10) | 否 | 每页数据显示条数。字段不填默认为1000,设置范围为1~1000 |
参数说明:
[{
"id": "6404841350757337303",
"setting_id": "8953082409304430269",
"setting_name": "指定商品",
"creator_id": "6802790356603352633",
"creator_name": "人员1",
"create_time": "2018-06-30 16:41:29",
"customer_id": "6522836289768729779",
"customer_name": "客户1",
"dimension_type":"1",
"dimension_id":"7705423564150216819",
"dimension_code":"CODE",
"dimension_name":"维度描述",
"year": "2018",
"month": "7",
"quarter": "3",
"kpi_value": "213.00"
}]
参数 | 类型 | 说明 |
---|---|---|
id | VARCHAR(32) | 客户月目标设置id |
setting_id | VARCHAR(32) | 指标id |
setting_name | VARCHAR(200) | 指标名称 |
creator_id | VARCHAR(32) | 创建人id |
creator_name | VARCHAR(200) | 创建人名称 |
create_time | VARCHAR(200) | 创建时间。格式:yyyy-MM-dd HH:mm:ss |
customer_id | VARCHAR(32) | 被设置目标的客户id |
customer_name | VARCHAR(200) | 被设置目标的客户名称 |
dimension_type | VARCHAR(32) | 维度类型。1:为商品,2:为商品类型,3:为商品品牌,4:为拜访任务。指定维度时显示此字段) |
dimension_id | VARCHAR(32) | 维度id。指定维度时显示此字段 |
dimension_code | VARCHAR(32) | 维度code。指定维度时显示此字段 |
dimension_name | VARCHAR(32) | 维度描述。指定维度时显示此字段 |
year | VARCHAR(4) | 年 |
month | VARCHAR(2) | 月 |
quarter | VARCHAR(1) | 季度 |
kpi_value | numeric(12,2) | 目标值 |