方舟智能分析
产品功能SDK指南API
  • 产品简介
  • 快速上手
    • Step 1 安装部署
    • Step 2 激活系统创建项目
    • Step 3 开启您的分析旅程
      • 1. 集成 SDK
      • 2. 可视化埋点
      • 3. 创建分析模型
    • 附:埋点方案设计
    • 附:数据分析思路
  • 产品更新日志
    • V5.3.3 UI 升级、分布分析重构、维度表动态更新、细节优化等
    • V5.2.0 新增归因分析、消息中心、重构埋点方案、优化看数据体验……
    • V5.1.0317 体验优化& Bug修复
    • V5.1.0 升级可视化埋点、增强权限控制……
  • 我要反馈
  • 🐱Part I 产品功能说明
    • 名词解释
    • 指标说明
    • 看板
    • 分析
      • 事件分析
      • 渠道分析
        • 渠道相关名词解释
        • 来源识别规则
        • 搜索引擎
        • 社交媒体
        • 小程序场景值
        • Session 规则
      • Session 分析
      • 实时分析
      • 留存分析
      • 转化漏斗
      • 智能路径
      • 归因分析(Beta)
      • 热图分析
        • Web/H5 热图
        • APP 热图
      • 分布分析
      • 间隔分析
      • 属性分析
      • 自定义查询
    • 用户
      • 用户探查
      • 用户分群
      • 用户标签
        • 标签体系
        • 标签加工
          • 如何自定义SQL创建标签
        • 标签生命周期管理
        • 标签体系应用概览
      • 单用户档案
    • 运营
      • 电子邮件
      • 短信
      • 消息通知
      • 广告跟踪
      • App 推广监测(Beta)
    • 项目管理
      • 项目概览
      • 项目角色管理
      • 项目成员管理
      • 数据接入管理
        • 埋点方案
        • 可视化埋点
        • 集成SDK接入数据
        • 数据验证
        • 用户数据导入
      • 元数据管理
        • 元事件
        • 虚拟事件
        • 事件属性
        • 用户属性
        • Session 管理
        • 页面组管理
        • 维度表
      • 服务集成配置
      • 监控告警
        • 智能监控
        • 自定义监控
    • 平台管理
      • 企业概览
      • 项目管理
      • 成员管理
      • 安全设置
      • 企业设置
      • 日志管理
      • 帐号设置
  • 🐵Part II 技术文档
    • 技术接入准备工作
      • 部署环境检测工具
      • 数据模型
      • 数据格式
      • 预置事件和属性
        • App预置事件/属性
        • JS 预置事件/属性
      • 如何准确识别用户
      • 如何设计埋点方案
      • 分平台上报数据 vs 跨平台打通
    • SDK 指南
      • Android SDK
        • 快速集成
        • 全埋点模块
        • 消息推送模块
        • Android Hybrid模式
        • SDK Gradle集成方式
        • 多渠道打包
        • 易观小工具
        • 合规相关
      • iOS SDK
        • 快速集成
        • 全埋点介绍
        • iOS Hybrid模式
        • 消息推送模块
      • JS SDK
        • 快速集成
        • JS SDK基础版
        • JS SDK插件
      • 微信小程序 SDK
        • 快速集成
        • 微信小程序标准版
        • 微信小程序插件版
        • 微信小程序通用框架版
      • 支付宝小程序 SDK
        • 支付宝小程序标准版
        • 支付宝小程序通用框架版
      • 字节跳动小程序 SDK
        • 字节跳动小程序标准版
        • 字节跳动小程序通用框架版
      • 百度小程序 SDK
        • 百度小程序标准版
        • 百度小程序通用框架版
      • 钉钉小程序 SDK
        • 钉钉小程序标准版
        • 钉钉小程序通用框架版
      • QQ小程序 SDK
        • QQ小程序标准版
        • QQ小程序通用框架版
      • 快应用 SDK
      • 华为WeCode小程序
        • WeCode SDK 标准版
        • WeCode SDK插件
      • PhoneGap SDK
      • mPaaS SDK
      • ReactNative SDK
      • Flutter SDK
      • Java SDK
      • Python SDK
      • PHP SDK
      • C++ SDK
      • C# SDK
      • Node JS SDK
      • Lua SDK
      • Golang SDK
      • SDK FAQ
        • identify与alias的区别
        • 爬虫数据如何识别?
        • 页面停留如何获取时间?
        • 如果获取SDK及更新日志
        • 代码埋点和无埋点有什么区别
        • Web页面中发现丢失某一个事件
        • 自研 SDK 注意事项
        • 页面时长统计功能
    • 数据验证
      • 客户端埋点验证
      • Debug 数据验证
      • 数据入库验证
    • 数据导入
      • 接口导入
      • JAVA工具包
        • 标准json文件导入
        • csv格式导入
      • 数据导入FAQ
    • 数据导出
      • JAVA工具包
        • 事件数据导出
        • 用户数据导出
      • 直接从Kafka中消费数据
      • 使用程序访问数据库
    • 脚本工具
    • API
      • 分析API
        • 事件分析
        • 留存分析
        • 转化漏斗
        • 属性分析
        • Session分析
        • 渠道分析
        • 分布分析
        • 自定义查询
      • 用户API
        • 分群查询
        • 用户档案
        • 分群管理
      • 管理API
        • 权限管理
        • 元数据管理
        • 埋点方案管理
        • 维度表管理
      • 运营API
        • 广告跟踪
      • 平台管理API
        • 项目管理
        • 成员管理
    • 第三方登录
      • OAuth2.0登录
      • LDAP登录
    • GDPR 合规
  • �� Part III 常见问题
    • License 许可
    • 产品试用及采购
    • 参与贡献
由 GitBook 提供支持
在本页
  • 1. 获取项目列表
  • 1.1 接口地址
  • 1.2 请求参数示例
  • 1.3 返回结果示例
  • 1.4 接口调用示例
  • 2. 获取单个项目详细
  • 2.1 接口地址
  • 2.2 请求参数示例
  • 2.3 返回结果示例
  • 2.4 接口调用示例
  • 3. 创建新项目
  • 3.1 接口地址
  • 3.2 请求参数示例
  • 3.3 返回结果示例
  • 3.4 接口调用示例
  • 4 开启/关闭数据流
  • 4.1 接口地址
  • 4.2 请求参数示例
  • 4.3 返回结果示例
  • 4.4 接口调用示例

这有帮助吗?

  1. Part II 技术文档
  2. API
  3. 平台管理API

项目管理

上一页平台管理API下一页成员管理

最后更新于5年前

这有帮助吗?

1. 获取项目列表

1.1 接口地址

【GET】 /uba/manage/enterprise/projects

1.2 请求参数示例

无

认证参数:接口必传 xtoken 参数,详情见 。

操作用户:接口如果要记录操作人,URL上带loginUser参数,详情见 。

1.3 返回结果示例

[
    {
        "appKey": "streamingut608",
        "normalToken":"xxxx",
        "cname": "streaming单元测试项目",
        "version": "4.2.7",
        //以下字段在【4.5.1版本】中新增
        "logo": "/data/static/files/logo/aaa.png",
        "createTime": 1578901233445,
        "sdkBack": "iOS,Android,H5",
        "status": 1,
        "partitionNum": 3,
        "stream": 0
    }
]

1.3.1 出参说明:

参数名称

类型

说明

appKey

String

项目AppKey

normalToken

String

项目内接口授权码

cname

String

项目名称,用于展示

version

String

项目当前版本信息

logo

String

项目图标访问路径,默认不显示,只有上传logo后显示

createTime

Long

十三位时间戳

sdkBack

String

已回数SDK接入平台(如 Java,JS,Android ),未回数时不显示

status

int

项目状态;1表示正常,2表示已删除,3表示异常不可用,只返回状态值1的项目

partitionNum

int

数据存储分区数

stream

int

项目数据数据流状态;0表示未启动,1表示启动中,2表示已启动,3表示异常中断,5表示关闭中

1.4 接口调用示例

curl -H "Content-Type:application/json" -H "xtoken:9CF0444E9DFD9E3D9CAE49B79F939B61" -X GET http://127.0.0.1:4005/uba/manage/enterprise/projects

2. 获取单个项目详细

2.1 接口地址

【GET】 /uba/manage/enterprise/projects/{appKey}

2.2 请求参数示例

无

2.2.1 入参说明:

参数名称

类型

必填

说明

appKey

String

Y

项目App标识,备注:URL传参

2.3 返回结果示例

{
    "appKey":"streamingut608",
    "cname":"streaming单元测试项目",
    "version":"4.2.7",
    "logo":"/data/static/files/logo/aaa.png",
    "createTime":1578901233445,
    "sdkBack":"iOS,Android,H5",
    "status":1,
    "partitionNum":3,
    "stream":0
}

2.3.1 出参说明:

参数名称

类型

说明

appKey

String

项目AppKey

cname

String

项目名称,用于展示

version

String

项目当前版本信息

logo

String

项目图标访问路径,默认不显示,只有上传logo后显示

createTime

Long

十三位时间戳

sdkBack

String

已回数SDK接入平台(如 Java,JS,Android ),未回数时不显示

status

int

项目状态;

1表示正常,2表示已删除,3表示异常不可用,只返回状态值1的项目

partitionNum

int

数据存储分区数

stream

int

项目数据数据流状态;0表示未启动,1表示启动中,2表示已启动,3表示异常中断,5表示关闭中

2.4 接口调用示例

curl -H "Content-Type:application/json" -H "xtoken:9CF0444E9DFD9E3D9CAE49B79F939B61" -X GET http://127.0.0.1:4005/uba/manage/enterprise/projects/streamingut608

3. 创建新项目

3.1 接口地址

【POST】 /uba/manage/enterprise/projects

3.2 请求参数示例

{
      "appKey":" streamingut608",
      "name":"测试项目"
}

3.2.1 入参说明:

参数名称

类型

必填

说明

appKey

String

Y

新项目的AppKey标识,只接受英文数字组合,不传系统自动生成。

备注:Body参数

name

String

Y

项目名称,只接受英文数字组合。

3.3 返回结果示例

{
    "appKey": "streamingut608",
    "success": 0
}

3.3.1 出参说明:

参数名称

类型

说明

appKey

String

项目AppKey

success

Integer

0表示创建完成,无异常。

备注:因为项目创建需要调配非常多系统资源,所以该接口为异步操作,项目真正可用状态需要调用【项目详情】接口,其中status 字段表示项目创建情况

3.4 接口调用示例

curl -H "Content-Type:application/json" -H "xtoken:9CF0444E9DFD9E3D9CAE49B79F939B61" -X POST --data '{" appKey ":" streamingut608","name ":"测试项目"}'  http://127.0.0.1:4005/uba/manage/enterprise/projects

4 开启/关闭数据流

4.1 接口地址

【POST】 /uba/manage/enterprise/projects/{appKey}/stream

4.2 请求参数示例

{
    //数据流状态 true为开启数据流 false为关闭数据流 关闭数据流功能在4.5版本中新增
    "streamSwitch": true
}

认证参数:接口必传 xtoken 参数,详情见 平台接口认证。

操作用户:接口如果要记录操作人,URL上带loginUser参数,详情见 操作用户。

4.2.1 入参说明:

参数名称

类型

必填

说明

枚举

appKey

String

Y

新项目的AppKey标识,只接受英文数字组合,不传系统自动生成。备注:URL参数

streamSwitch

Boolean

Y

数据流状态 true为开启数据流,false为关闭数据流。

备注:关闭数据流在4.5版本中才会支持。

true/false

4.3 返回结果示例

{
  //0表示操作成功,数据流开启/关闭中
  "success": 0
}

4.3.1 出参说明:

参数名称

类型

说明

success

Integer

0表示操作成功,数据流开启/关闭中。备注:因为开启数据流/关闭数据流是异步操作,接口调用只是发起了相关请求,最终的操作结果需要通过streamStatus查看最终启停状态。

4.4 接口调用示例

curl -H "Content-Type:application/json" -H "xtoken:E1E967DCE07B10839F87195B78E1F5F5" -X POST --data '{
    "streamSwitch": true
}' http://127.0.0.1:4005/uba/manage/enterprise/projects/streamingut608/stream?loginUser=admin@analysys.com.cn

认证参数:接口必传 xtoken 参数,详情见 。

操作用户:接口如果要记录操作人,URL上带loginUser参数,详情见 。

认证参数:接口必传 xtoken 参数,详情见 。

操作用户:接口如果要记录操作人,URL上带loginUser参数,详情见 。

🐵
平台接口认证
操作用户
平台接口认证
操作用户
平台接口认证
操作用户