经营驾驶舱中查询用户可见指标
路径 | /industry/dashboard/visible/indicator/list |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
corpId | String | 否 | 企业标识,每个企业拥有唯一的CorpID,比如钉钉corpID、LH里面的appId | |
userId | String | 否 | 员工在当前企业内的唯一标识,钉钉userId或者IoT的employeeId | |
source | String | 否 | 源,枚举值,钉钉填写DINGDING,多住户saas填SAAS | |
agentId | String | 否 | 代表企业应用ID | |
platForm | String | 否 | 平台参数,字符串,至少包括手机型号信息,屏幕信息 | |
appId | String | 否 | 三方应用appId,可选参数 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
id | Long |
惟一标识 |
|
name | String |
指标名称 |
|
precision | Int |
显示精度 |
|
unit | String |
指标单位 |
|
description | String |
指标描述 |
|
icon | String |
指标图片 |
|
showPercentage | Boolean |
是否指百分比显示 |
|
periodType | String |
周期类型。日(DAY);周(WEEK);月(MONTH);季度(QUARTER);年(YEAR) |
|
comparisonType | String |
比较类型。同比(YEAR_ON_YEAR);环比(PERIOD_TO_PERIOD) |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1"
},
"params":{
"corpId": "value0",
"userId": "value1",
"source": "value2",
"agentId": "value3",
"platForm": "value4",
"appId": "value5"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": [{
"id":1,
"name":"测试指标",
"comparisonType":"YEAR_ON_YEAR",
"periodType":"WEEK",
"showPercentage": true
}]
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 22000 | Query Result is Empty | 查询结果为空 |
200 | 22000 | Query Result is Empty | 查询结果为空 |