获取画像报告详情 - GetInsightReportById--客户数据平台-火山引擎

文档中心

导航

获取画像报告详情 - GetInsightReportById

最近更新时间：2025.01.15 11:35:29首次发布时间：2024.07.12 14:50:48

请求说明

请求方式：GET
接口名称：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	项目ID，参考附录-项目ID获取方式

Query

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

Body

无

返回参数

参数	类型	示例值	描述
msg	String	succeed	响应信息
code	Int	0	响应码，0=成功
data	OpenAPiInsightReportResp	{}	结果

OpenAPiInsightReportResp

参数	类型	示例值	描述
desc	String	描述	描述信息
graphs	Array	[]	图表信息
isMine	Boolean	false	是否是当前用户创建的：true，只看由我创建的报告
creator	String	admin	创建者
segInfo	Array	[]	分群包基础信息
isBooked	Boolean	false	是否加入收藏
isPublic	Boolean	false	是否是公域洞察报告
reportId	Number	1	报告id
createAt	String	2024-06-12 15:21:04	创建时间
subjectId	Number	1	主体id
updatedAt	String	2024-08-20 03:57:24	更新时间
onSchedule	Boolean	false	是否开启实时更新
reportName	String	子账户按天	报告名称
scheduleTime	String	10:00	定时计算时间格式：HH：MM
latestRunTime	String	2024-08-28 01:29:12	此次结果的运行时间
summaryResult	SummaryResult	{}	概览结果
insightDomainId	Number	1	报告分组id
insightDomainName	String	默认分组	报告分组名

GraphSimpleResult

参数	类型	示例值	描述
graphData	Array	[]	图表结果
graphName	String	测试图表	图表名称
graphType	String	CustomAnalysis	图表类型：CustomAnalysis、CrossAnalysis、PublicCustomAnalysis

InsightRecord

参数	类型	示例值	描述
insightFull	Int	69	业务大盘
insightTagTgi	Int	100	标签tgi
insightFullTgi	Int	100	大盘tgi
insightTagName	Stirng	gender	标签名称
insightTagValue	String	男	标签值
insightTagCoverage	Number	0.5	标签占比
insightSegmentation	String	分群1	分群包
insightTagProportion	Int	12098	标签人数
insightTagTgiLowBound	Int	50	标签tgi下限
insightTagTgiUppBound	Int	100	标签tgi上限
insightFullTgiLowBound	Int	50	大盘tgi下限
insightFullTgiUppBound	Int	100	大盘tgi上限
insightVerticalTagName	String	recent_city	标签2名称
insightVerticalTagValue	String	背景	标签2取值
insightEffectiveCoverage	Number	0.5	标签有效占比
insightHorizontalTagName	String	gender	标签1名称
insightHorizontalTagValue	String	男	标签1取值

SegInfo

参数	类型	示例值	描述
segName	String	分群1	分群包名称
coverage	Number	100	覆盖率
segCount	Number	12098	分群数量
coverCount	Number	12098	分群覆盖量

SummaryResult

参数	类型	示例值	描述
summary	Array	[]	标签概览，默认取标签占比最大的前50个标签值的信
tagOutline	Array	[]	标签总结信息，分群中各标签标签人数 * TGI 最大的10个标签值
segCountResults	Array	[]	多分群覆盖率，无对照分群时此项为null insightDomainId

InsightSummarySegObj

参数	类型	示例值	描述
segName	String	分群2	分群名称
summaryInfo	Array	[]	群中各标签标签人数 * TGI 最大的10个标签的信息，结构同上

InsightSummaryTagObj

参数	类型	示例值	描述
tgi	Number	100	大盘TGI
tagId	Number	1	标签id
target	Number	200	标签人数 * TGI
segName	String	分群1	分群名称
tagName	String	gender	标签名称
tagValue	String	男	标签值
validTgi	Number	100	标签 TGI
tagProportion	Number	100	大盘占比
tagValidProportion	Number	100	标签有效占比

请求示例

GET /?ApiAction=GetInsightReportById&ApiVersion=2023-02-10&reportId=1&singleValue=false&insightSortObj=Full&sortType=Tag&pDate=2024-08-20

返回示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "reportId": 113,
        "reportName": "子账户按天",
        "subjectId": 1,
        "desc": "",
        "creator": "zj_中文",
        "isMine": false,
        "isPublic": false,
        "createdAt": "2024-06-12 15:21:04",
        "updatedAt": "2024-08-20 03:57:24",
        "segInfo": [
            {
                "segName": "分群1",
                "segCount": 138
            }
        ],
        "graphs": [
            {
                "graphName": "gender",
                "graphType": "CustomAnalysis",
                "graphData": [
                    {
                        "insightTagName": "gender",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "男",
                        "insightTagCoverage": 0.5,
                        "insightFull": 69,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 0.5,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    },
                    {
                        "insightTagName": "gender",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "女",
                        "insightTagCoverage": 0.5,
                        "insightFull": 69,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 0.5,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    }
                ]
            },
            {
                "graphName": "gender",
                "graphType": "CustomAnalysis",
                "graphData": [
                    {
                        "insightTagName": "gender",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "男",
                        "insightTagCoverage": 0.5,
                        "insightFull": 69,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 0.5,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    },
                    {
                        "insightTagName": "gender",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "女",
                        "insightTagCoverage": 0.5,
                        "insightFull": 69,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 0.5,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    }
                ]
            },
            {
                "graphName": "xiaoshu",
                "graphType": "CustomAnalysis",
                "graphData": [
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[0.62,1.26)",
                        "insightTagCoverage": 0.9927536231884058,
                        "insightFull": 137,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 0.9927536231884058,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[-0.66,-0.02)",
                        "insightTagCoverage": 0.007246376811594203,
                        "insightFull": 1,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 0.007246376811594203,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[-1.30,-0.66)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[-0.02,0.62)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[1.26,1.90)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[1.90,2.54)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[2.54,3.18)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[3.18,3.82)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[3.82,4.46)",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "xiaoshu",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "[4.46,5.10]",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    }
                ]
            },
            {
                "graphName": "recent_city",
                "graphType": "CustomAnalysis",
                "graphData": [
                    {
                        "insightTagName": "recent_city",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "北京",
                        "insightTagCoverage": 1.0,
                        "insightFull": 138,
                        "insightFullTgi": 100,
                        "insightEffectiveCoverage": 1.0,
                        "insightTagTgi": 100,
                        "insightCustomTgi": 100
                    },
                    {
                        "insightTagName": "recent_city",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "厦门",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    },
                    {
                        "insightTagName": "recent_city",
                        "insightSegmentation": "分群1",
                        "insightTagValue": "上海",
                        "insightTagCoverage": 0.0,
                        "insightFull": 0,
                        "insightFullTgi": 0,
                        "insightEffectiveCoverage": 0.0,
                        "insightTagTgi": 0,
                        "insightCustomTgi": 0
                    }
                ]
            }
        ],
        "summaryResult": {
            "summary": null,
            "tagOutline": null,
            "segCountResults": null
        },
        "isBooked": false,
        "insightDomainId": 7,
        "insightDomainName": "默认分组",
        "onSchedule": true,
        "scheduleTime": "01:00",
        "latestRunTime": "2024-08-28 01:29:12"
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	invalidParameter	PARAMETER INVALID	参数非法，检查入参。

客户数据平台