分析洞察相关--客户数据平台-火山引擎

文档中心

导航

分析洞察相关

最近更新时间：2024.10.14 15:36:28首次发布时间：2023.10.08 10:43:10

1. 获取画像报告列表

基本信息

生效版本	1.18
功能描述	获取用户有权限访问的画像报告列表，目前只支持私域报告
接口模块	InsightApi
接口名称	GetInsightReportList
请求类型	GET
权限校验	需要模块权限检验

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	String	是	租户Code
X-Env	String	否	多环境下需指定环境信息，默认“dev”

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10

Body （无）

响应参数

名称	数据类型	描述
reportId	Integer	报告Id
reportName	String	报告名称
subjectId	subjectId	主体Id
desc	String	描述信息
creator	String	创建者
isMine	Boolean	是否是当前用户创建的：true，只看由我创建的报告
createdAt	Datetime	创建时间
updatedAt	Datetime	更新时间
historyDate	Array[Date]	历史报告日期

返回示例

{
  "data": [                                    // 报告列表
    {
      "reportId": 1,                           // 报告Id
      "reportName": "Openapi 报告",            //  报告名
      "subjectId": 2,                         //  主体Id
      "desc": "画像报告",                      //  描述信息
      "creator": "user1",                    //  创建者
      "isMine": true,                        //  是否是当前用户创建的：true，当前用户是此报告的创建者； 
      "createdAt": "2023-02-17 07:32:53",    //  创建时间
      "updatedAt": "2023-02-17 07:32:53",    //  更新时间
      "historyDate": [                       //  历史报告日期
        "2023-02-17"
      ]
    }
  ],
  "code": 0
}

2. 获取画像报告详情

基本信息

生效版本	1.18
功能描述	根据 reportId 获取画像报告详情，目前只支持私域报告
接口模块	InsightApi
接口名称	GetInsightReportById
请求类型	POST
权限校验	需要模块权限检验

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	String	是	租户Code
X-Env	String	否	多环境下需指定环境信息，默认 “dev”

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10
reportId	Integer	是	报告ID
pDate	String	否	报告日期，`YYYY-HH-MM` 格式。可取值为报告列表 `historyDate`，默认最近一次报告日期
singleValue	Boolean	否	标签概览中的标签统计维度：`False` 代表从全量所有标签值选取标签占比最高的前50个标签值，`True` 代表*每个标签分别取UVTGI最显著的标签值，再取最多50条标签展示**，默认 `False`。
insightSortObj	String	否	控制对照人群差异概览结果的排序方式，可选`Full`、`Effective`；对应的结果将按全量人群或有效人群降序排列，默认值`Effective`。与sortType 参数组合使用。
sortType	String	否	控制对照人群差异概览结果的排序方式，可选`Tag`、`Tgi`、`Uv`。对应的结果将按标签人数、TGI、UV 降序排列，默认值 `Tgi`。与 insightSortObj 参数组合使用

注意

1.18 版本暂未加入对照人群差异概览数据，因此，insightSortObj、sortType 暂时无效果，使用sdk请求时请传 null

Body （无）

响应参数

名称	数据类型	描述
reportId	Integer	报告Id
reportName	String	报告名称
subjectId	subjectId	主体Id
desc	String	描述信息
creator	String	创建者
isMine	Boolean	是否是当前用户创建的：true，只看由我创建的报告
isPublic	Boolean	是否是“其他”洞察报告
createdAt	Datetime	创建时间
updatedAt	Datetime	更新时间
isBooked	Boolean	是否加入收藏
insightDomainId	Integer	报告分组id
insightDomainName	String	报告分组名
onSchedule	Boolean	是否开启定时更新
scheduleTime	String	定时计算时间格式 HH:MM
latestRunTime	Datetime	此次结果的运行时间
segInfo	Array[Object]	人群包基础信息 segName // 人群名称 segCount // 人群数量
graphs	Array[Object]	图表信息 graphName：图表名称 graphType：图表类型：CustomAnalysis，自定义分析；CrossAnalysis，交叉分析 graphData：图表结果，详见下方示例
summaryResult	Object	总结描述
summaryResult.tagOutline	Array[Object]	标签概览，默认取标签占比最大的前50个标签值的信息 tagId // 标签id tagName // 标签名称 tagValue // 标签值 target // 标签人数 * TGI tgi // 大盘TGI tagProportion // 大盘占比 segName： // 分群名称 validTgi // 标签TGI agValidProportion // 标签有效占比
summaryResult.summary	Array[Object]	标签总结信息，分群中各标签标签人数 * TGI 最大的10个标签值 segName // 分群名称 summaryInfo // 分群中各标签标签人数 * TGI 最大的10个标签的信息，结构同上
summaryResult.segCountResults	Array[Object]	多人群覆盖率，无对照人群时此项为null segName // 人群名称 segCount // 人群数量 coverCount //人群覆盖量 coverage // 覆盖率

返回示例

{
  "data": {                                        // 报告详情
    "reportId": 1,                                 // id
    "reportName": "Openapi 报告",                   // 报告名称
    "subjectId": 1,                                // 主体id
    "desc": "画像报告",                             // 描述信息
    "creator": "user1",                            // 创建者
    "isMine": true,                                //是否是当前用户创建
    "isPublic": false,                             
    "createdAt": "2023-02-16 07:41:21",            // 创建时间
    "updatedAt": "2023-02-16 07:41:21",            // 更新时间
    "segInfo": [                                   // 人群包基础信息
      {    
        "segName": "分群1",                         // 人群名称
        "segCount": 1000                           // 人群数量
      },
      {
        "segName": "分群2",
        "segCount": 1024
      }
    ],
    "graphs": [                                    // 图表信息
      {
        "graphName": "学历",                       // 图表名称
        "graphType": "CustomAnalysis",            // 图表类型：CustomAnalysis，自定义分析；CrossAnalysis，交叉分析
        "graphData": [
          {
            "insightTagName": "学历",              // 标签名称
            "insightSegmentation": "分群1",        // 人群包
            "insightTagValue": "本科",             // 标签值
            "insightTagCoverage": 0.618,           // 标签占比
            "insightFull": 1000,                    // 业务大盘
            "insightFullTgi": 100,                    // 大盘TGI
            "insightEffectiveCoverage": 0.618,       // 标签有效占比
            "insightTagTgi": 100                    // 标签TGI
          }
        ]
      },
      {
        "graphName": "学历x收入",                       
        "graphType": "CrossAnalysis",
        "graphData": [
          {
            "insightHorizontalTagName": "学历",       // 标签1名称
            "insightHorizontalTagValue": "本科",      // 标签1取值
            "insightVerticalTagName": "收入",          // 标签2名称
            "insightVerticalTagValue": "中等收入",        // 标签2取值
            "insightTagCoverage": 0.618,            // 标签占比
            "insightTagProportion": 618               //标签人数
          }
        ]
      }
    ],
    "summaryResult": {                                          // 总结描述
      "summary": [                                              // 分群中各标签 标签人数 * TGI 最大的10个标签
        {
          "segName": "分群1",                                     
          "summaryInfo": [
            {                                                    // 标签信息
              "tagId": 1,                                        // 标签id
              "tagName": "学历",                                  // 标签名称
              "tagValue": "本科",                                 // 标签值
              "target": 61800,                                    // 标签人数 * TGI
              "tgi": 100,                                         // 大盘TGI
              "tagProportion": 0.0618,                             // 大盘占比
              "segName": "分群1",
              "validTgi": 100,                                    //  标签TGI
              "tagValidProportion": 0.618                         // 标签有效占比
            }
          ]
        }
      ],
      "tagOutline": [                                            // 标签概览，默认取标签占比最大的前50个
        {                                                        // 数据结构同 summaryInfo
          "tagId": 1,
          "tagName": "学历",
          "tagValue": "本科",
          "target": 61800,
          "tgi": 100,
          "tagProportion": 0.618,
          "segName": "分群1",
          "validTgi": 100,
          "tagValidProportion": 0.618
        }
      ],
      "segCountResults": [                                      // 多分群覆盖率，只有一个人群时此项为null
        {
          "segName": "分群1",                                   // 人群名称
          "segCount": 1000,                                    // 人群数量
          "coverCount": 120,                                    //人群覆盖量
          "coverage": 0.12                                      // 覆盖率
        },
        {
          "segName": "分群2",
          "segCount": 1024,
          "coverCount": 512,
          "coverage": 0.5
        }
      ]
    },
    "isBooked": true,                                            // 是否加入收藏
    "insightDomainId": 1,                                        // 报告分组id
    "insightDomainName": "默认分组",                              // 报告分组名
    "onSchedule": true,                                          // 是否开启定时更新
    "scheduleTime": "00:00",                                     // 定时计算时间 HH:MM
    "latestRunTime": "2023-02-17 07:41:21",                      // 报告运行时间
  },
  "code": 0,
}

3. 统计画像报告调用次数

基本信息

生效版本	1.19
功能描述	统计当前用户查看各画像报告的次数，目前只支持私域报告
接口模块	InsightApi
接口名称	GetInsightReportUsage
请求类型	GET
权限校验	无需校验（不会访问报告，只统计埋点记录）

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	String	是	租户Code
X-Env	String	否	多环境下需指定环境信息，默认 “dev”

Param

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20
openapiOnly	Boolean	否	是否只统计经openapi调用画像报告次数，默认 `false`，统计的是报告的页面浏览和 2. 获取画像报告详情接口调用；为 `true` 时，只统计 3. 统计画像报告调用次数接口调用

响应参数

名称	数据类型	描述
reportId	Integer	报告Id
reportName	String	报告名称
usage	subjectId	当前用户查看此报告的次数

样例：

{
  "data": [
      {
          "reportId": 10,                                            // 报告Id
          "reportName": "Openapi 报告",                              // 报告名称
          "usage": 10                                               // 当前用户查看此报告的次数
      },
      {
          "reportId": 11,
          "reportName": "画像报告2",
          "usage": 20
      }
  ],
  "code": 0,
}