行为画像接口


获取作品访客行为统计接口

  • 接口描述:根据作品ID、指定时间段、获取指定维度的统计数据。行为画像数据展示为T-1,例如想看2022-09-06日数据,需要在2022-09-07号才能查看到数据展示

  • 接口地址:/api/v1/preview/statistic/behavior?token=TOKEN&creationId=xxx&startTime=xxx&endTime=xxx&types=xxx

  • 请求方式:GET

  • 传参方式:

  • 参数列表:

    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
    types String 纬度定义,多个维度之间使用逗号分隔,不可为空,维度数据查询,默认无数据依旧返回X轴用于客户展示,维度为:访问次数、访问时长、页面访问时长、页面退出率
    startTime String 查询开始日期、例:2021-12-01
    endTime String 查询截止日期,最大查询日期为昨日数据,当日为空、例:2021-12-01
  • types具体维度介绍:

    定义 名称 说明
    funnel 转化漏斗 返回为具体数字,大于0 为对应漏斗层级的维度
    relay 访客转发率 分享转发所占百分比,小数点后两位 总数
    visitsCount 访问次数分布 数字
    duration 访问时长分布 百分比小数展示
    subPageDurationCount 子页面,访问时长分布 数值,每个子页面访问的总时长,单位秒
    subPageLeaveCount 页面离开率 百分比小数展示
    elementClick 按钮点击分布 百分比小数展示
    brand 品牌型号 返回为百分比小数点后4位,例如0.9333 为百分比93.33%,后续简称百分比小数展示
    channel 渠道分析 百分比小数展示
    device 访客设备 百分比小数展示
  • 代码示例:
    {
      "success": true,
      "code": 200,
      "msg": "操作成功",
      "obj": {
          "subPageLeaveCountKey": ["第1页"],
          "subPageLeaveCountVal": [1.0],
          "subPageDurationCountVal": [237.83],
          "brandKey": ["Apple", "other"],
          "relayVal": [],
          "brandVal": [0.9333, 0.0667],
          "subPageDurationCountKey": ["第1页"],
          "deviceKey": ["Android", "PC", "iOS"],
          "durationKey": ["小于10秒", "10秒-1分钟", "1-3分钟", "3-5分钟", "5分钟以上"],
          "deviceVal": [0.0667, 0.5333, 0.4],
          "durationVal": [7.0, 8.0, 0.0, 0.0, 0.0],
          "elementClickKey": [],
          "elementClickVal": [],
          "channelVal": [0.6, 0.4],
          "channelKey": ["pc浏览器", "其他"],
          "funnelKey": ["uv"],
          "funnelVal": [6.0],
          "relayKey": [],
          "visitsCountKey": ["1次", "2次", "3次", "4次", "5次", "5次以上"],
          "visitsCountVal": [2.0, 1.0, 0.0, 0.0, 0.0, 1.0]
      },
      "map": null,
      "list": null
    }
    
  • 返回参数obj:
    根据查询维度返回,并不是所有维度响应参数都会出现
    数组类型每个维度包含一个key数组以及val数值数组
    例如查询types=visitsCount返回内容会包含
    visitsCountKey: 具体维度的展示数据例如 1次,2次,3次
    visitsCountVal: 每个维度的具体数据 例如1次对应的值。2次对应的值
    参数 参数类型 说明
    funnelKey 数组类型[]
    funnelVal 数组类型[]
    relayKey 数组类型[]
    relayVal 数组类型[]
    visitsCountKey 数组类型[]
    visitsCountVal 数组类型[]
    durationKey 数组类型[]
    durationVal 数组类型[]
    subPageDurationCountKey 数组类型[]
    subPageDurationCountVal 数组类型[]
    subPageLeaveCountKey 数组类型[]
    subPageLeaveCountVal 数组类型[]
    elementClickKey 数组类型[]
    elementClickVal 数组类型[]
    brandKey 数组类型[]
    brandVal 数组类型[]
    channelKey 数组类型[]
    channelVal 数组类型[]
    deviceKey 数组类型[]
    deviceVal 数组类型[]

获取作品地域统计数据

  • 接口描述:根据作品ID获取作品的访问地域统计数据。
  • 接口地址:/api/v1/preview/statistic/behavior/region?token=TOKEN&creationId=xxx&startTime=xxx&endTime=xxx&type=xxx&limit=xx&province=
  • 请求方式:GET
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
    type String province:查询省份,city:查询城市
    limit int 查询前多少个
    province String 当type=city时,可以查询具体省份下的城市
    startTime String 查询开始日期、例:2021-12-01
    endTime String 查询截止日期,最大查询日期为昨日数据,当日为空、例:2021-12-01
  • 代码示例:
    {
      "success": true,
      "code": 200,
      "msg": "操作成功",
      "obj": {
          "regionKey": ["北京", "海外"],
          "regionVal": [0.5, 0.5]
      },
      "map": null,
      "list": null
    }
    
  • 返回参数obj:
    参数 参数类型 说明
    regionKey 数组类型[] 具体地域信息,按pv排名递减顺序
    regionVal 数组类型[] 每个地域对应的百分比数值

古月加贝 2024年7月2日 09:43 3008 收藏文档