一.从项目内移除成员
通过邮箱删除用户,用于清理项目内失效成员。
https://www.growingio.com/api/v1/projects/{project_uid}/accounts/delete
POST
请求参数
响应示例
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
string | 是 | 待删除的成员邮箱。 |
响应示例
200: OK
{ "status": "success" }
400: Bad Request 请求失败,message 中会有错误消息
{ "status": "fail", "message": "error message" }
403: Forbidden 认证失败
二.获取埋点事件列表
返回当前项目打点事件,没有结果时返回空数组。
https://www.growingio.com/v1/api/projects/{project_uid}/dim/events
GET
请求参数
返回示例
名称 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
返回示例
返回成功时:
[ { "id": "id1", // 事件 uid "key": "test1", // 事件标识符 "name": "测试1", // 事件名称 "description": "测试", // 事件描述 "type": "counter", // 事件类型, counter: 计数器, number: 数值 "attrs": [ // 事件级变量 { "id": "id2", // 变量 uid "key": "labore111", // 变量标识符 "name": "变量1", // 变量名称 "type": "String", // 变量类型, 目前有 String, Int, Double 类型 "projectId": "id3", // 项目 uid "createdAt": 1534820494000, // 变量创建时间,unix 毫秒时间戳 "updatedAt": 1534820494000 // 变量最后一次更新时间, unix 毫秒时间戳 } ], "projectId": "id3", // 项目 uid "createdAt": 1534426936000, // 事件创建时间, unix 毫秒时间戳 "updatedAt": 1535425076000, // 事件最后一次更新时间, unix 毫秒时间戳 "creator": "User1", // 创建人 "updater": "User1", // 最后一次更新人 "eventType": "dash" // 事件类型, 目前仅有 dash,表示为打点事件 } ]
三.创建埋点事件
创建打点事件,注意目前仅支持创建,不支持修改,如需修改,请到 GrowingIO 平台管理界面修改。打点事件支持批量创建,如果一次仅创建一条,body 内也需要使用数组形式。
https://www.growingio.com/v1/api/projects/{project_uid}/dim/events
POST
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_uid | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 是 | 事件名称,最大长度为30字符 |
type | string | 是 | 事件类型。
|
key | string | 是 | 事件标识符,只允许以字母或下划线开头,包含下划线、字母和数字的字符串,最大长度是50. |
description | string | 否 | 事件描述。 |
attrs | array | 否 | 事件关联的维度属性。 |
attrs字段为事件需要关联的维度属性,以下为attrs对应的字段:
名称 | 类型 | 说明 |
id | Sring | 事件级变量的UID。 |
key | string | 事件级变量标识符。 |
name | string | 事件级变量类型,目前有string、int、double三种类型。 |
响应示例
200:OK
四.获取事件级变量
获取项目下打点维度列表。
https://www.growingio.com/v1/api/projects/{project_uid}/vars/events
GET
请求参数
路径参数类型 | 类型 | 是否必传 | 书名 |
peojext_id | string | 是 | 项目UID。 |
返回示例
[ { "id": "id1", // 打点维度 uid "key": "test1", // 打点维度标识符 "name": "测试", // 打点维度名称 "type": "String", // 打点维度类型,目前有 String, Int, Double 三种类型 "projectId": "pid1", // 项目 uid "createdAt": 1534820494000, // 打点维度创建时间, unix 毫秒时间戳 "updatedAt": 1534820494000 // 打点维度最后更新时间, unix 毫秒时间戳 } ]
五.创建事件级变量
创建事件级变量,目前仅支持创建,不支持修改,如需修改,请到 GrowingIO 平台管理界面修改。
https://www.growingio.com /v1/api/projects/{project_uid}/vars/events
POST
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_id | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 是 | 变量名称,最大长度为30 |
key | string | 是 | 变量标识符,只允许以字母获下划线开头,包含下划线、字码、数字的字符串,最大长度为30 |
type | string | 否 | 变量类型。
默认为string。 |
description | string | 否 | 变量描述,最大长度150。 |
返回示例
200: OK
六.获取页面级变量
返回当前项目的页面级变量列表。
https://www.growingio.com /v1/api/projects/{project_uid}/vars/pages
GET
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_id | string | 是 | 项目UID。 |
返回示例
[ { "id": "id1", // 变量 uid "key": "test1", // 变量标识符 "name": "测试", // 变量名称 "mode": "DIRECT", // 变量创建方式,DIRECT: 通过接口或则打点管理创建, PAGE: 通过页面圈选创建 "projectId": "pid1", // 项目 uid "createdAt": 1521446011241, // 创建时间, unix 毫秒时间戳 "updatedAt": 1534163546862, // 最后一次更新时间, unix 毫秒时间戳 "mappingId": 15 // 变量序号 } ]
七.创建页面级变量
创建页面级变量,目前仅支持创建,不支持修改,如需修改,请到 GrowingIO 平台管理界面修改。
https://www.growingio.com /v1/api/projects/{project_uid}/vars/pages
POST
请求参数
路径名称 | 类型 | 是否必传 | 说明 |
project_id | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 是 | 变量名称,最大长度30. |
key | string | 是 | 变量标识符,字母或下划线开头,包含下划线,字母,数字的字符串」,最大长度为 50 |
description | string | 否 | 变量描述:最大长度50 |
响应示例
200: OK
八.获取登录用户变量
获得当前项目登录用户变量列表。
https://www.growingio.com /v1/api/projects/{project_uid}/vars/peoples
GET
请求参数
路径参数 | 类型 | 是否必传 | 说明 |
project_id | string | 是 | 项目UID。 |
返回示例
[ { "id": "id1", // 变量 uid "key": "test1", // 变量标识符 "name": "测试", // 变量名称 "description": "测试", // 变量描述 "projectId": "pid1", // 项目 uid "createdAt": 1532416276546, // 变量创建时间, unix 毫秒时间戳 "updatedAt": 1532416276546, // 变量最后一次修改时间, unix 毫秒时间戳 "attribution": "mostRecent" // 变量类型,mostRecent: 最近归因,final: 最终归因 } ]
九.创建登录用户变量
创建登录用户变量,目前仅支持创建,不支持修改,如需修改请到 GrowingIO 平台管理界面修改。
https://www.growingio.com /v1/api/projects/{project_uid}/vars/peoples
POST
参数说明
路径参数 | 类型 | 是否必传 | 说明 |
project_id | string | 是 | 项目UID。 |
body参数 | 类型 | 是否必传 | 说明 |
name | string | 是 | 变量名称,最大长度为30 |
key | string | 是 | 变量标识符,只允许以字母或下划线开头,包含下划线、字母、数字的字符串,最大长度为50. |
attribution | string | 是 | 归因方式
|
description | string | 否 | 变量描述,最大长度为150 |
返回示例
200: OK
十.获取埋点数量限额
GrowingIO 根据付费版本设定不同的埋点事件和维度的限额,通过此接口获取您项目的限额。
https://www.growingio.com /v1/api/projects/{project_uid}/vars/quotas
GET
参数说明
路径参数 | 类型 | 是否必传 | 说明 |
project_id | string | 是 | 项目UID。 |
返回示例
200:OK
{ "event": 50000, // 打点事件限额 "var": 100, // 事件级变量限额 "pvar": 50, // 页面级变量限额 "ppl": 50000 // 登录用户变量限额 }