方舟智能分析
产品功能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

广告跟踪

方舟5.4.1版本中新增API。

1. 创建广告跟踪

创建一个广告跟踪。

1.1 接口地址

【POST】 /ark/uba/api/operations/utm

1.2 请求参数示例

// 【非必填】通过urlPath传参, username是创建人的用户名
loginUser=?
// body 中传参
{
    // 【必填】目标网址
    "pageUrl": "http://www.baidu.com",
    // 【必填】广告名称
    "utmCampaign": "xx平台广告",
    // 【必填】广告媒介
    "utmMedium": "品牌搜索",
    // 【必填】广告来源
    "utmSource": "微博",
    // 广告内容
    "utmContent": "点击领取优惠券",
    // 广告关键字
    "utmTerm": "优惠券",
    // 备注
    "remarks": ""
}

1.3 返回结果示例

{
    "success":0, 
    // 广告跟踪唯一标识
     "campaignId": 124343232
}

1.4 接口调用示例

curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
    "utmType": "H5",
    "pageUrl": "http://www.baidu.com",
    "utmCampaign": "xx平台广告",
    "utmMedium": "品牌搜索",
    "utmSource": "微博",
    "utmContent": "点击领取优惠券",
    "utmTerm": "优惠券",
    "remarks": ""
}' http://127.0.0.1:4005/ark/uba/api/operations/utm?username=admin

2. 获取广告跟踪

获取广告跟踪信息, 包括长短链

2.1 接口地址

【GET】 /ark/uba/api/operations/utm/{campaignId}

2.2 请求参数示例

//【必填】广告跟踪唯一标识 url路径参数
/ark/uba/api/operations/utm/124343232

2.3 返回结果示例

{
    "id": 4,
    "campaignId": "1591933676",
    "utmType": "eee",
    "callbackUrl": null,
    "pageUrl": "www.as.com",
    "utmCampaign": "",
    "utmMedium": "xcczx",
    "utmSource": "ew",
    "utmContent": "fdf",
    "utmTerm": "fvdfv",
    "checkUrl": null,
    "checkShort": null,
    "checkQrcode": null,
    "url": "www.as.com?campaign_id=1591933676&utm_campaign=&utm_medium=xcczx&utm_source=ew&utm_content=fdf&utm_term=fvdfv",
    "shortUrl": "utmJNOubA",
    "qrcode": null,
    "remarks": "s",
    "appKey": "apitestauto",
    "userId": -99,
    "status": 1,
    "createTime": 1618458179000,
    "updateTime": 1618486625000,
    "canOperated": 0,
    "createName": null,
    "loginName": null,
    "email": null,
    "phone": null,
    "uniqueSign": "1591933676",
    "batchNum": null,
    "project": null,
    "originUrl": null
}

2.4 接口调用示例

curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X GET  http://127.0.0.1:4005/ark/uba/api/operations/utm/124343232

3 查看转化效果‌

查询该广告跟踪的转化效果

3.1 接口地址

【POST】 /ark/uba/api/operations/utm/analysys/{campaignId}

3.2 请求参数示例

{
    // 【必填】查询起始日期
    "fromDate": "2021-04-03",
    // 【必填】查询结束日期
    "toDate": "2021-04-12",
    "useCache": true,
    // 转化目标
    "expression":"event.login"
       
}

3.3 返回结果示例

{
  "success":0
}

3.4 接口调用示例

curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
    "convertMeasures":[
        {
            "expression":"event.login",
            "aggregator":"TRIGGER_USER_COUNT"
        }
    ],
    "fromDate": "2021-04-03",
    "toDate": "2021-04-12",
    "useCache": true
}' http://127.0.0.1:4005/ark/uba/api/operations/utm/analysys/124343232

4. 删除广告跟踪‌

逻辑删除广告跟踪数据

4.1 接口地址

【DELETE】 /ark/uba/api/operations/utm/drop/{campaignId}

4.2 请求参数示例

//【必填】广告跟踪唯一标识 url路径参数
/ark/uba/api/operations/utm/drop/124343232

4.3 返回结果示例

{
  "success":0
}

4.4 接口调用示例

curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X DELETE http://127.0.0.1:4005/ark/uba/api/operations/utm/drop/124343232
上一页运营API下一页平台管理API

最后更新于4年前

这有帮助吗?

认证参数:接口必传token和appKey两个参数,详情见 。

认证参数:接口必传token和appKey两个参数,详情见 。

认证参数:接口必传token和appKey两个参数,详情见 。

认证参数:接口必传token和appKey两个参数,详情见 。

🐵
项目接口认证
项目接口认证
项目接口认证
项目接口认证