互动数据接口--内容洞察平台-火山引擎

文档中心

立即注册

导航

互动数据接口

最近更新时间：2024.07.11 14:18:25首次发布时间：2024.01.11 10:56:24

本文档介绍内容洞察数据的互动消费数据获取接口的调用方式。

概述

内容洞察的内容数据在客户场景使用时，客户业务会对内容在火山主端的消费数据有依赖，因此，内容洞察提供互动数据查询接口，客户侧可根据业务需要，通过内容ID，实时获取内容的消费数据。

备注：
对于公域不公开可见的内容，无法查询内容的消费数据（如内容设私密、作者设私密等）
接口调用前置操作，详见：调用指南

请求接口

基本信息

名称	内容
接口地址	/openapi/item/v1/interaction
请求方式	GET
是否需要鉴权	是
QPS限制	150

请求参数

Header请求参数

字段	类型	是否必填	说明
X-Insight-Biz-Name	string	是	业务名称，见「数据流管理」-API配置-「账号ID」
X-Insight-Access-Token	string	是	访问凭证，获取方式调用指南
Content-Type	string	是	'application/json'

Query请求参数

字段	类型	是否必填	说明
origin_id	string	必填，post_id/origin_id二选一	抖音原始ID，可在抖音url中获取
post_id	string	必填，post_id/origin_id二选一	洞察发文ID，可在洞察推送的发文数据结构中获取

返回参数

字段			类型	说明
status			int	0为成功
message			string	返回错误信息
data	post_stats	like_count	string	点赞数
		comment_count	string	评论数
		collect_count	string	收藏数
		share_count	string	分享数

调用示例

请求示例

GET /openapi/item/v1/interaction?post_id=<xxxxxxxx>

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token
Content-Type: application/json

返回示例

{
    "status": 0,
    "message": "succeed",
    "data": {
        "post_stats": {
            "like_count": "20.0w", // 点赞数
            "comment_count": "12.8w", // 评论数
            "collect_count": "6227", // 收藏数
            "share_count": "36.6w" // 分享数
        }
    }
}