KPI结果
概览
获取计划下的KPI结果有两种方式
- 主动调用获取KPI结果的接口
- 由我们系统在KPI计算完成时自动推送结果。详见KPI结果更新
获取KPI结果
通过plan_id获取计划的KPI结果
请求信息
| 配置说明 | 参数值 |
|---|---|
| URL | /plan/kpi |
| Method | GET |
Query参数
| 参数名 | 类型 | 描述 | 是否必填 |
|---|---|---|---|
| plan_id | string | 计划id | 是 |
响应数据
| 参数名 | 类型 | 描述 |
|---|---|---|
| plan_id | string | 计划id |
| update_time | int64 | 结果更新时间（毫秒时间戳） |
| status | int32 | 0-待处理；2-完成；3-失败 |
| store_code | string | 门店编码 |
| results | []object | 自定义分组的KPI结果 |
| + group_type | string | 分组规则 |
| + metrics | []object | 分组的指标列表 |
| ++ group_values | []object | 分组具体的值 |
| +++ name | string | 分组值对应的名称 |
| +++ value | string | 分组值 |
| ++ kpis | []object | 分组后具体的KPI值 |
| +++ extra_info | string | KPI的额外信息，比如PSKU的barcode |
| +++ name | string | KPI的名称 |
| +++ view_tab | string | KPI的同属的tab |
| +++ sub_group_type | string | 二次分组的类型，目前只有task |
| +++ sub_group_values | []object | 二次分组的值 |
| ++++ name | string | 分组值对应的名称 |
| ++++ value | string | 分组值 |
| +++ sub_kpis | []object | 该KPI的子KPI，结构同kpis |
| +++ value | string | KPI的结果 |
响应数据说明
目前KPI分组规则有以下类型：
- 品类 + 场景：体现为
group_type为scene_code，group_values由name为scene_code，value为约定的场景值构成 - 任务：体现为
group_type为task，group_values由name为task_id，value为具体任务id的值构成
响应数据样例
json
{
"code": 0,
"message": "",
"data": {
"plan_id": "P2506030702016564724",
"update_time": 1668478888000,
"store_code": "Ytd2T0Kr7VKb",
"status": 2,
"results": [
{
"group_type": "scene_code",
"metrics": [
{
"group_values": [
{
"name": "scene_code",
"value": "ST-qorDZ"
}
],
"kpis": [
{
"name": "Display Share%",
"value": "",
"view_tab": "",
"extra_info": "",
"sub_kpis": [
{
"name": "P\u0026G Display Share%",
"value": "33.33%",
"view_tab": "",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "",
"sub_group_values": null
},
{
"name": "Pantene Display Share%",
"value": "0%",
"view_tab": "",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "",
"sub_group_values": null
}
],
"sub_group_type": "",
"sub_group_values": null
},
{
"name": "Layer Number",
"value": "1",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": [
{
"name": "二楼洗护发高新品陈列\u003e=6瓶",
"value": "N",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "5f77da06-755b-4e6a-a206-edbaa0178be8"
}
]
}
],
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "5f77da06-755b-4e6a-a206-edbaa0178be8"
}
]
},
{
"name": "P\u0026G CEP Compliance",
"value": "N",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": [
{
"name": "一楼洗发水护发素连带陈列",
"value": "100:0",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "5f77da06-755b-4e6a-a206-edbaa0178be8"
}
]
},
{
"name": "一楼洗发水清晰可见且\u003e=6支",
"value": "Y",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "5f77da06-755b-4e6a-a206-edbaa0178be8"
}
]
}
],
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "5f77da06-755b-4e6a-a206-edbaa0178be8"
}
]
},
{
"name": "潘婷丝质顺滑型润发精华素塑料管200g",
"value": "0.00%",
"view_tab": "SKU Percentage",
"extra_info": "{\"barcode\":\"6903148091371\"}",
"sub_kpis": null,
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "5f77da06-755b-4e6a-a206-edbaa0178be8"
}
]
}
]
},
{
"group_values": [
{
"name": "scene_code",
"value": "ST-VVtsA"
}
],
"kpis": [
{
"name": "Ariel/Tide CEP Compliance",
"value": "N",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": [
{
"name": "汰渍净白5KG/汰渍净白4.1KG/碧浪3.5KG",
"value": "N",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "731193e3-8653-46cf-93a3-3cbdd09e7a81"
}
]
},
{
"name": "汰渍3KG/4KG/5KG（汰渍区）",
"value": "N",
"view_tab": "Type \u0026 Compliance",
"extra_info": "",
"sub_kpis": null,
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "731193e3-8653-46cf-93a3-3cbdd09e7a81"
}
]
}
],
"sub_group_type": "task",
"sub_group_values": [
{
"name": "task_id",
"value": "731193e3-8653-46cf-93a3-3cbdd09e7a81"
}
]
}
]
}
]
}
]
}
}