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

文档中心

立即注册

导航

StayLog - 详情页停留时长上报

最近更新时间：2024.05.28 18:13:35首次发布时间：2021.10.18 11:12:18

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

请求说明

请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
请求地址：https://mercury.volcengineapi.com/?Action=StayLog&Version=2021-01-01
请求头：ServiceName:content

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	StayLog	要执行的操作，取值：StayLog。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	xxx_default_content	渠道号。
AccessToken	String	是	AT6zTZuXzxxxpQamerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12	用户唯一标识。
GroupId	String	是	7366891164987048482	内容id。
StayTime	String	是	1000	表示在详情页停留的时长，单位：毫秒，不包含锁屏&切后台的停留时长。
EventTime	String	是	1716457710	事件发生时间，十位时间戳，单位：秒；表示点击退出详情页事件发生时的时间。
Percent	String	是	50	最大阅读进度。表示图文内容的实际阅读进度，取值范围1～100。根据当前已阅读的高度/内容的总高度计算。注意需记录当次阅读的最大进度。举例说明：进入详情页，划到文章底部，此时记录100，再划到文章顶部，退出，上报记录过的最大进度即100。 percent文章完整比例不包含评论区内容。视频内容不上报此参数。
ReqId	String	是	20220721103117010210043037253714CD	请求唯一标识。表示该内容具体是从哪一次请求返回的，便于数据分析。该值对应公共响应参数中的RequestId。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Result	String	success	上报结果，success：成功。

请求示例

GET /?Action=StayLog&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzxxxpQamerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&GroupId=7366891164987048482&StayTime=1000&EventTime=1716457710&Percent=50&ReqId=20220721103117010210043037253714CD HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=StayLog&Version=2021-01-01
X-Date: 20240527T075738Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240527/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202405271436351861970481163BFB7E",
    "Action": "StayLog",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": "success"
}

错误码

您可访问公共错误码，获取更多错误码信息。