埋点数据上传API(Beta)

GW
Last updated 29 days ago

接口方法

POST(GET方法后续支持)

数据接口URL

https://api.growingio.com/v3/${ai}/s2s/cstm?stm=${sendingTime}

请求变量说明

字段名称

字段说明

字段示例

ai

项目ID

参见GrowingIO产品中 项目管理 模块

​ sendingTime

​ 发送时间时间戳(毫秒)

​1506069592985

data

本次事件的内容

json格式字符串,参考后续内容

Body格式:

单条事件发送

[
{
"cs1":"9128391",
"tm":1434556935000,
"t":"cstm",
"n":"BuyProduct",
"var":{
"product_name":"苹果",
"product_classify":"水果",
"product_price":14
}
}
]

多条事件发送

[
{
"cs1":"9128391",
"tm":1434556935000,
"t":"cstm",
"n":"BuyProduct",
"var":{
"product_name":"苹果",
"product_classify":"水果",
"product_price":14
}
},
{
"cs1":"9128391",
"tm":1434556935000,
"t":"cstm",
"n":"BuyProduct",
"var":{
"product_name":"苹果",
"product_classify":"水果",
"product_price":14
}
},
{
"cs1":"9128391",
"tm":1434556935000,
"t":"cstm",
"n":"BuyProduct",
"var":{
"product_name":"苹果",
"product_classify":"水果",
"product_price":14
}
}
]

Body字段说明

字段名称

是否必填

字段格式

字段说明

字段值示例

cs1

字符串

用户登录ID

9128391

长度限制255,且字符串中不能包含":"

invalidCS1: ["0", "1", "-1", "{user.id}",null]

tm

数值

事件发生时间时间戳(毫秒)

1506069592985

n

字符串

事件标识

intcmpEntry

长度限制255

var

对象

所有的自定义事件变量

key:value

value:若为字符串,长度限制255

value:若为数值,可以为整数,小数(支持多个小数位)

t

字符串

固定cstm

cstm

固定

程序调试

GrowingIO建议您按照如下步骤进行埋点数据的开发联调

  1. 在GrowingIO的网站中创建自定义事件以及对应的自定义事件变量

  2. 参考上面的文档,编写一段程序上传一个事件,确保收到了200的HTTP状态

  3. 在GrowingIO产品中使用您创建的埋点数据创建一个实时的图表

  4. 如果可以在实时产品中看到您的埋点数据统计,则代表您的埋点创建成功