经营驾驶舱中查询指标展示数据

路径 /industry/dashboard/indicator/display/data/get
版本号 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 否 平台参数，字符串，至少包括手机型号信息，屏幕信息
id Long 是 指标id
currentDate String 是 当前日期，日期格式如："2019-02-01"
comparisonType String 是 比较类型，枚举值。同比填YEAR_ON_YEAR；环比填PERIOD_TO_PERIOD
periodType String 是 周期类型，枚举值。日填DAY；周填WEEK；月填MONTH；季度填QUARTER；年填YEAR
appId String 否 三方应用appId，可选参数

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功
message String

错误消息
localizedMsg String

本地语言错误消息
data JSON

指标展示数据
current Double

当前数据
rate Double

比率

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1"
	},
	"params":{
		"corpId": "value0",
		"userId": "value1",
		"source": "value2",
		"agentId": "value3",
		"platForm": "value4",
		"id": "value5",
		"currentDate": "value6",
		"comparisonType": "value7",
		"periodType": "value8",
		"appId": "value9"
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "current": 15.08,
        "rate": 3.01
    }
}

异常返回示例

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 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 403 request forbidden. 请求被禁止
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 460 request parameter error. 请求参数错误
200 460 request forbidden 请求被禁止
200 1009 SQL invoke error SQL 执行出错
200 460 request parameter error. 请求参数错误
200 500 server error. 系统错误
200 403 request forbidden. 请求被禁止