You need to enable JavaScript to run this app.
导航
GetInsightReportById - 获取画像报告详情
最近更新时间:2024.07.25 14:46:09首次发布时间:2024.07.10 15:50:09

请求说明

  • 请求方式:POST
  • 接口名称:GetInsightReportById
  • 请求地址:https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

Int

1

租户Code

X-Env

String

多环境下需指定环境信息,默认“dev”

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

GetInsightReportById

对应“请求说明”中的“接口名称”

ApiVersion

String

2023-02-10

版本号: 2023-02-10

reportId

Integer

报告ID

singleValue

Boolean

True

标签概览中的标签统计维度:False 代表从全量所有标签值选取标签占比最高的前50个标签值True 代表每个标签分别取UV*TGI最显著的标签值,再取最多50条标签展示,默认 False

insightSortObj

String

Full

控制对照人群差异概览结果的排序方式,可选FullEffective
对应的结果将按全量人群有效人群降序排列,默认值Effective。与sortType 参数组合使用。

sortType

String

Tag

控制对照人群差异概览结果的排序方式,可选TagTgiUv。对应的结果将按标签人数TGIUV 降序排列,默认值 Tgi。与 insightSortObj 参数组合使用

pDate

String

2024-05-12

报告日期,YYYY-HH-MM 格式。可取值为报告列表 historyDate,默认最近一次报告日期

Body


返回参数

data数组元素字段内容

参数

类型

示例值

描述

reportId

Integer

报告Id

reportName

String

报告名称

subjectId

Integer

主体Id

desc

String

描述信息

creator

String

创建者

isMine

Boolean

是否是当前用户创建的:true,只看由我创建的报告

isPublic

Boolean

是否是公域洞察报告

createdAt

String

创建时间

updatedAt

String

更新时间

segInfo

Array[Object]

人群包基础信息
segName // 人群名称
segCount // 人群数量

graphs

Array[Object]

图表信息
graphName:图表名称
graphType:图表类型:CustomAnalysis,自定义分析;CrossAnalysis,交叉分析
graphData:图表结果,详见下方示例

summaryResult

Object

总结描述

isBooked

Boolean

是否加入收藏

insightDomainId

Integer

报告分组id

insightDomainName

String

报告分组名

onSchedule

Boolean

是否开启定时更新

scheduleTime

String

定时计算时间格式 HH:MM

latestRunTime

Datetime

此次结果的运行时间

segInfo数组元素字段内容

参数

类型

示例值

描述

segName

String

segCount

Integer

coverCount

Integer

coverage

Double

graphs数组元素字段内容

参数

类型

示例值

描述

graphName

String

graphType

String

summaryResult字段内容

参数

类型

示例值

描述

summary

Array[Object]

segName

标签总结信息,分群中各标签 标签人数 * TGI 最大的10个标签值
segName // 分群名称
summaryInfo // 分群中各标签 标签人数 * TGI 最大的10个标签的信息,结构同上

tagOutline

Array[Object]

tagId

标签概览,默认取标签占比最大的前50个标签值的信息
tagId // 标签id
tagName // 标签名称
tagValue // 标签值
target // 标签人数 * TGI
tgi // 大盘TGI
tagProportion // 大盘占比
segName: // 分群名称
validTgi // 标签TGI
agValidProportion // 标签有效占比

segCountResults

Array[Object]

null

多人群覆盖率,无对照人群时此项为null
segName // 人群名称
segCount // 人群数量
coverCount //人群覆盖量
coverage // 覆盖率

请求示例


返回示例


错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。