文档首页/ 推荐系统 RES/ API参考/ API（V1不推荐）/ 全局配置API/ 全局指标配置
更新时间：2023-05-24 GMT+08:00
查看PDF
分享

全局指标配置

功能介绍

该接口用于提交全局指标配置。

URI

POST /v1/{project_id}/global-setting

参数说明请参见表1-URI参数说明。
表1 URI参数说明

名称

是否必选

类型

说明

project_id

是

String

项目编号，用于资源隔离。获取方法请参见获取项目ID。

请求消息

请求参数请参见表2所示。

表2 请求参数说明

参数名称

是否必选

参数类型

说明

type

是

String

指标类型。

parameter

是

String

全局配置参数配置。

data_format

否

String

数据格式，用户属性表、物品属性表、用户操作行为表必填，值可以为“csv”和“json”。

data_param

否

JSON

data_format为csv时必填，其他可选。

scene_id

是

String

场景ID。
表3 data_param参数说明

参数名称

是否必选

参数类型

说明

header

是

String

是否显示表头。

  • true：有表头
  • false：无表头

delimiter

是

String

分隔符，最大长度10字符。

quote

是

String

引用字符，最大长度10字符。

escape

是

String

转义字符，最大长度10字符。

响应消息

响应参数请参见表4。

表4 响应参数说明

参数名称

参数类型

说明

is_success

Boolean

请求是否成功。

message

string

响应返回消息。

error_code

String

请求失败时的错误码，请求成功时无此字段。

error_msg

String

请求失败时的错误信息，请求成功时无此字段。

示例

  • 请求示例 
    {
	"type":"config_load_path",
	"parameter":"<全局配置参数存储路径>"
}
  • 成功响应示例 
    {
    "is_success": true,
    "message": "Succeed to add the global setting."
}
  • 失败响应示例 
    {
    "is_success": false,
    "error_code": "res.2301",
    "error_msg": "Failed to resolve the token from the request."
}

状态码

状态码请参见状态码。

父主题： 全局配置API

相关文档