猫酷开放平台

# BI数据

# 事件数据导入

TIP

事件数据导入，根据不同的事件导入对应的数据到猫酷系统，具体数据结构见各事件场景。

接口地址：https://openapi10.mallcoo.cn/BI/Event/v1/Data/Import/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
EventType int 是 事件类型
EventData string 是 对应事件数据（标准Json字符串，需UrlEncode，UTF-8 (UrlEncode)编码）

# 调用示例


{ 
	"EventType":2,
	"EventData": "{\"time\":\"2018-12-25 18:32:22\",\"shop_id\":\"12345\",\"unique_id\":\"unique_id\",\"order_total_price\":\"10.22\",\"payment_amount\":\"100.0\"}"
}
1
2
3
4
5
6

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
TraceID string 是 TraceID
# 返回示例

{
	"Code": 1,
	"Data":{"TraceID":"5da4257c8ecb70564b800001"},
	"Message": "成功"
}
1
2
3
4
5
6
7
# 事件常用参数说明：
参数 说明
time 事件发生的时间，根据各事件场景而定，例如停车缴费为缴费时间，车辆离场为离开停车场时间。
unique_id 事件唯一标识符，用于区分同一用户同一秒内发生的同一类型事件，通过此参数判断是否为重复数据。注意此字段不用做数据更新，如果同一天先后导入两条相同unique_id的记录，系统会随机覆盖其中一条，不保证后导入的数据覆盖前一条。推荐：将json按照key排序然后做MD5
身份标识字段 用于标识事件发起者或触发者，系统一般提供多种标识字段，这些字段至少需要传入一个。例如用户行为事件，一般提供会员卡号、手机号等标识；店铺行为事件，一般提供店铺编号等标识。 ID标识字段必须要有一个
# 事件类型枚举
事件类型 枚举值 事件名称
消费 504002 CRM消费积分
销售 401001 商家销售（废弃）
销售 401002 商家销售
商家 301001 商家到达
客流 103001 视频客流
客流 103002 FaceID到场
车场 909001 缴纳停车费
车场 909002 车辆进出场
车场 909003 预约停车
车场 909004 代客泊车
车场 909007 车场使用情况
车场 909008 车辆月租
车场 909009 充电桩充电
车场 909010 充电桩充值
VIP室 505001 进出VIP室
浏览 601001 打开应用页面
团购 901001 购买团购
团购 901002 核销团购
团购 901003 退货团购
问卷 901201 问卷提交
卡券 908001 券领取
卡券 908002 券核销
卡券 908004 第三方领卡
活动 903001 报名活动
活动 903002 参与活动
注册 501001 用户注册
会员 502001 开绑会员卡
会员 502002 会员卡升降级
积分 503001 积分变动
积分 503011 积分抵现
电影票 906001 购买电影票
用户 905001 用户签到
消费 504006 会员商品购买
销售 401006 店铺商品销售



# 商家数据导入

TIP

商家数据导入

接口地址：https://openapi10.mallcoo.cn/BI/Shop/v1/Data/Import/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
ShopData string 是 对应数据数据（标准Json字符串，需UrlEncode，UTF-8 (UrlEncode)编码）ShopModel

# 调用示例


{ 
	"ShopData": "{\"mall_id\": \"1\",\"shop_code\": \"shop_codesdfasd\",\"shop_id\": \"shop_id\",\"rent_type\": \"rent_type\",\"rent\": 12345.2,\"property\": \"property\",\"sales_point\": 456.23,\"open_time\": \"2018-12-24\",\"end_time\": \"2019-12-24\",\"cash_mode\": \"cash_mode\",\"house_number\": \"house_number\",\"contract_status\": \"contract_status\",\"mall_coordinator\": \"mall_coordinator\",\"store_cash_method\": \"store_cash_method\",\"commercial_type_to_b\": \"commercial_type_to_b\",\"sub_commercial_type_to_b\": \"sub_commercial_type_to_b\"}"
}
1
2
3
4
5

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
TraceID string 是 TraceID
# 返回示例

{
	"Code": 1,
	"Data":{"TraceID":"5da4257c8ecb70564b800001"},
	"Message": "成功"
}
1
2
3
4
5
6
7
# ShopModel
名称 数据类型 必填 说明
shop_code string 否 第三方商家编号，对应Mallcoo系统的shopcode(shop_code、dev_shop_id任一必填)
dev_shop_id string 否 该商户在本开发者中的唯一编号(shop_code、dev_shop_id任一必填)
shop_name_to_b string 否 店铺名(ToB)
rent_type string 否 租赁方式
shop_structure_area double 否 店铺建筑面积
property string 否 铺位性质
rent double 否 固定租金
sales_point double 否 扣率
open_time string 否 开业时间
end_time string 否 结业时间
cash_mode string 否 收银模式
house_number string 否 门牌号
contract_status string 否 合同状态
mall_coordinator string 否 商场协调人
store_cash_method string 否 商家收银方式
commercial_type_to_b string 否 一级业态(to B)
sub_commercial_type_to_b string 否 二级业态(to B)
third_commercial_type_to_b string 否 三级业态(to B)
remark string 否 备注
brand_number_to_b string 否 品牌编号(to B)，即第三方（如ERP）系统店铺所属品牌
building_number_to_b string 否 所属楼栋(to B)，即第三方（如ERP）系统店铺所属楼栋
shop_number_to_b string 否 店铺编码(to B)，即第三方（如ERP）系统店铺编码
contract_number_to_b string 否 合同编码(to B)，即第三方（如ERP）系统合同编号



# 用户标签查询

TIP

通过手机号或者用户卡号获取用户的标签

接口地址：https://openapi10.mallcoo.cn/BI/User/v1/Get/TagList/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
Mobile string 是 用户手机号【与用户卡号 、OpenUserID 三选一】
MallCardNo string 是 用户卡号【与用户手机号、OpenUserID 三选一】
OpenUserID string 是 用户在当前【开发者账号+项目（集团）】下的唯一标识(相当于用户ID)【与用户手机号、用户卡号三选一】
IsGroup Boolean 是 是否是查询集团项目的标签

# 调用示例


{ 
	"Mobile":"13641726191",
	"MallCardNo":null,
	"OpenUserID":null,
	"IsGroup":false,
}
1
2
3
4
5
6
7
8

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data list<UserTagModel> 是 返回数据
Message string 是 返回状态描述
# UserTagModel
名称 数据类型 必填 说明
Name string 是 用户标签名称，如“高活跃度会员”
Group string 是 用户标签分组，如“金卡会员”标签所属分组为“会员卡级”
Type string 是 用户标签类别，如“成熟会员”标签所属类别为“会员生命周期标签”
# 返回示例


{
	"Code": 1,
	"Data": [{
		"Name": "手机号有值",
		"Group": "手机号有值",
		"Type":"自定义标签"
	}, {
		"Name": "活跃用户",
		"Group": "活跃用户",
		"Type":"自定义标签"
	}, {
		"Name": "潜在用户",
		"Group": "潜在用户",
		"Type":"自定义标签"
	}, {
		"Name": "会员人数",
		"Group": "会员人数",
		"Type":"自定义标签"
	}, {
		"Name": "忠诚用户",
		"Group": "忠诚用户",
		"Type":"自定义标签"
	}],
	"Message": "成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28



# 项目标签查询

TIP

项目标签查询

接口地址：https://openapi10.mallcoo.cn/BI/Project/v1/Get/MallTags/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
IsShowGroup Boolean 否 是否需要获取该mall对应的集团项目的标签

# 调用示例


{ 
	"IsShowGroup":false,
}
1
2
3
4
5

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data list<MallTagModel> 是 返回数据
Message string 是 返回状态描述
# MallTagModel
名称 数据类型 必填 说明
ProjectId long 是 项目ID
ProjectName string 是 项目名称
ProjectType int 是 项目类型 0单项目 1集团
DefaultTags List<Tag> 是 预设标签
CustomTags List<Tag> 是 自定义标签
ThirdPartyTags List<Tag> 是 第三方标签
# Tag
名称 数据类型 必填 说明
Name string 是 标签名称
Group string 是 标签分组
Type string 否 标签分类
ExecuteCount int 是 标签人数
# 返回示例


{
	"Code": 1,
	"Data": [{
		"ProjectId": 18,
		"ProjectName": "测试人脸识别10010-正式",
		"ProjectType": 0,
		"DefaultTags": [],
		"CustomTags": [{
			"Name": "活跃用户",
			"Group": "活跃用户",
			"Type": null,
			"ExecuteCount":1
		}, {
			"Name": "潜在用户",
			"Group": "潜在用户",
			"Type": null,
			"ExecuteCount":1
		}, {
			"Name": "忠诚用户",
			"Group": "忠诚用户",
			"Type": null,
			"ExecuteCount":1
		}, {
			"Name": "手机号有值",
			"Group": "手机号有值",
			"Type": null,
			"ExecuteCount":1
		}, {
			"Name": "会员人数",
			"Group": "会员人数",
			"Type": null,
			"ExecuteCount":1
		}, {
			"Name": "前年注册用户数据",
			"Group": "前年注册用户数据",
			"Type": null,
			"ExecuteCount":2
		}],
		"ThirdPartyTags": []
	}],
	"Message": "成功",
	"Extension": []
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# 用户打标签

TIP

给用户打标签(可批量)

接口地址：https://openapi10.mallcoo.cn/BI/User/v1/Import/TagList/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
TagList List<ImportTagParam> 是 标签信息列表
# ImportTagParam
名称 数据类型 必填 说明
Mobile string 是 用户手机号【与用户卡号 、OpenUserID 三选一】
MallCardNo string 是 用户卡号【与用户手机号、OpenUserID 三选一】
OpenUserID string 是 用户在当前【开发者账号+项目（集团）】下的唯一标识(相当于用户ID)【与用户手机号、用户卡号三选一】
TagGroup string 是 标签组 (中文需UrlEncode，UTF-8 (UrlEncode)编码)
TagName string 是 标签名,标签组后边的具体标签名称，如“店铺偏好_优衣库”，若标签组下只存在一个标签名，则标签组保持一致 (中文需UrlEncode，UTF-8 (UrlEncode)编码)
TagValue string 否 标签值 (中文需UrlEncode，UTF-8 (UrlEncode)编码)

# 调用示例


{ 
	"TagList":[
		{
			"Mobile":"15155145475",
			"TagGroup":"%E6%B5%8B%E8%AF%95123",
			"TagName":"234",
			"TagValue":"value"
		},
		{
			"Mobile":"15155145476",
			"TagGroup":"%E6%B5%8B%E8%AF%95123",
			"TagName":"234",
			"TagValue":"value"
		},
	]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

 {
    "Code": 1,
    "Message": "成功"
}
1
2
3
4
5
6

# 用户删标签

TIP

给用户删标签(可批量)

接口地址：https://openapi10.mallcoo.cn/BI/User/v1/Delete/TagList/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
TagList List<DeleteTagParam> 是 标签信息列表
# DeleteTagParam
名称 数据类型 必填 说明
Mobile string 是 用户手机号【与用户卡号 、OpenUserID 三选一】
MallCardNo string 是 用户卡号【与用户手机号、OpenUserID 三选一】
OpenUserID string 是 用户在当前【开发者账号+项目（集团）】下的唯一标识(相当于用户ID)【与用户手机号、用户卡号三选一】
TagGroup string 是 标签组 (中文需UrlEncode，UTF-8 (UrlEncode)编码)
TagName string 否 标签名,标签组后边的具体标签名称,如“店铺偏好_优衣库”，若只传了标签组，没有传标签名，则猫酷平台将会删除标签组下所有的标签名;若标签组和标签名都传了则猫酷平台将会删除标签组下对应的标签名（其他标签名不会删除） (中文需UrlEncode，UTF-8 (UrlEncode)编码)

# 调用示例


{ 
	"TagList":[
		{
			"Mobile":"15155145475",
			"TagGroup":"%E6%B5%8B%E8%AF%95123",
			"TagName":"234"
		},
		{
			"Mobile":"15155145476",
			"TagGroup":"%E6%B5%8B%E8%AF%95123",
			"TagName":"234"
		},
	]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

 {
    "Code": 1,
    "Message": "成功"
}
1
2
3
4
5
6
Last Updated: 2021/11/29 下午3:33:34

← IMS数据 →