VerifyLog - 验证数据回传--内容定制-火山引擎

文档中心

立即注册

导航

VerifyLog - 验证数据回传

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

火山引擎提供了如下两种方式供客户进行埋点自测（验证数据回传），推荐使用方式一。
埋点自测通过后，请提供测试包由火山引擎进行二次验收。

使用场景

【方式一】内容定制控制台（推荐）
登录火山引擎内容定制控制台，进入埋点验收-数据校验模块，连接测试机并进行验收。具体操作请参见“埋点验收操作手册”。
【方式二】API
通过火山引擎提供的埋点（数据回传）验证接口，进行埋点自测。

注意事项

前提条件：
- 访问此接口前，需要联系火山引擎将测试机绑定的AccessToken加入测试白名单，否则访问会被拒绝。
- 需要先进行用户行为上报（数据回传），再请求该验证接口，否则会请求失败。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	VerifyLog	要执行的操作，取值：VerifyLog。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	xxx_default_content	渠道号。
AccessToken	String	是	AT6zTZuXzffKpQamxxxKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12	用户唯一标识。

返回参数

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

参数	类型	示例值	描述
Result	String	[{"req_id":"20220721103117010210043037253714CD","partner":"xxx","ut_uid":"14_1736492712420376","event":"go_detail","params":"{\"group_id\":6938426748178530823,\"item_id\":6938426748178530823,\"category_name\":\"standard_default_content_feed_1_59_v1\",\"enter_from\":\"click_category\",\"open_scene\":\"feed_2\",\"open_channel\":\"xxx\",\"app_version\":\"7.3.25\",\"os\":\"iOS\",\"dt\":\"iphone6s\",\"os_version\":\"12\",\"device_brand\":\"Apple\",\"mi_new_data\":\"-1\"}","event_time":"2022-07-21 10:31:17","timestamp":"2022-07-21 10:31:17"}]	已上报的事件列表。一般通过该列表来验证埋点上报结果是否符合预期。说明 Result字符串中的params是经过映射后的结果，和数据回传接口中传入的参数名称会有所差异。

请求示例

GET /?Action=VerifyLog&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzffKpQamxxxKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12 HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=VerifyLog&Version=2021-01-01
X-Date: 20240527T105311Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240527/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240527185342030062147193D6A536",
    "Action": "VerifyLog",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": "[{\\\"req_id\\\":\\\"20220721103117010210043037253714CD\\\",\\\"partner\\\":\\\"xxx\\\",\\\"ut_uid\\\":\\\"14_1736492712420376\\\",\\\"event\\\":\\\"go_detail\\\",\\\"params\\\":\\\"{\\\\\\\"group_id\\\\\\\":6938426748178530823,\\\\\\\"item_id\\\\\\\":6938426748178530823,\\\\\\\"category_name\\\\\\\":\\\\\\\"standard_default_content_feed_1_59_v1\\\\\\\",\\\\\\\"enter_from\\\\\\\":\\\\\\\"click_category\\\\\\\",\\\\\\\"open_scene\\\\\\\":\\\\\\\"feed_2\\\\\\\",\\\\\\\"open_channel\\\\\\\":\\\\\\\"xxx\\\\\\\",\\\\\\\"app_version\\\\\\\":\\\\\\\"7.3.25\\\\\\\",\\\\\\\"os\\\\\\\":\\\\\\\"iOS\\\\\\\",\\\\\\\"dt\\\\\\\":\\\\\\\"iphone6s\\\\\\\",\\\\\\\"os_version\\\\\\\":\\\\\\\"12\\\\\\\",\\\\\\\"device_brand\\\\\\\":\\\\\\\"Apple\\\\\\\",\\\\\\\"mi_new_data\\\\\\\":\\\\\\\"-1\\\\\\\"}\\\",\\\"event_time\\\":\\\"2022-07-21 10:31:17\\\",\\\"timestamp\\\":\\\"2022-07-21 10:31:17\\\"}]"
}

错误码

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