详情页停留时长上报--内容定制-火山引擎

文档中心

导航

详情页停留时长上报

最近更新时间：2023.12.22 11:01:19首次发布时间：2021.04.09 18:31:35

用于图文、短视频退出详情页的事件上报。

请求结构	说明
请求域名	stream-api.feedcoopapi.com【建议】 mercury.snssdk.com【废弃】
请求地址	/user/action/log/stay/v1/
请求协议	HTTP/HTTPS
请求方式	GET/POST
参数类型	application/x-www-form-urlencoded

请求参数

参数	描述	类型	是否必填	说明
group_id	内容id	long	是	对应“获取个性化内容”接口返回的group_id
stay_time	停留时长	long	是	表示在详情页停留的时长，单位：毫秒，不包含锁屏&切后台的停留时长。
event_time	事件发生时间	long	是	十位时间戳，单位：秒；表示点击退出详情页事件发生时的时间
percent	最大阅读进度	long	是	表示图文内容的实际阅读进度，取值范围1～100。根据当前已阅读的高度/内容的总高度计算。注意 1.需记录当次阅读的最大进度。举例说明：进入详情页，划到文章底部，此时记录100，再划到文章顶部，退出，上报记录过的最大进度即100。 2.percent文章完整比例不包含评论区内容。 3.视频内容不上报此参数。
req_id	请求唯一标识	String	是	唯一标识该内容源于哪次请求，比如推荐接口返回的req_id

响应参数

参数	描述	类型	说明
ret	响应结果	long	参见“错误码”说明
msg	本次请求是否成功	String	success：成功
req_id	本次请求标识	String	惟一标识本次请求，火山引擎侧使用该字段进行具体问题追踪和排查

请求示例

curl --location --request GET 'https://stream-api.feedcoopapi.com/user/action/log/stay/v1/?signature=54bf21452b8599034e6e5219864a5fd8f415a81a&timestamp=1656489292&nonce=894038&partner=server_sdk_demo_default_content&access_token=AEvgyaZ5cWcPS6m9jQhpXpjZ5xRued98RxaKYFX5NdjTDKXUEt8C3dGFXxmgoK9Sj5QvfXDPskhgrL87VVrmv7o6dPEsT7L&group_id=7115232373091860514&event_time=1656776132&req_id=xxx'

响应示例

{
    "data": [],
    "msg": "success",
    "req_id": "202207022356420102121921381DC39722",
    "ret": 0
}

常见问题

说明

Q：详情页默认是折叠的，需要点击“展开全文”才能查看内容，如何计算percent？
A：火山引擎H5详情页会在iframe onload的时机下，向客户H5壳子以postMessage的方式同步内容总高度（分母），客户侧需自主计算已阅读的内容高度（分子），percent=已阅读高度/内容总高度。