获取数据报表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /v4/openapi/app-groups/[appGroupIdentity]/scenes/[sceneId]/groups/[groupId]/metrics HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
appGroupIdentity | String | Path | 是 | my_app_group_name |
应用名称 |
groupId | Integer | Path | 是 | 13466 |
组ID |
sceneId | Integer | Path | 是 | 20404 |
场景ID |
字段 |
类型 |
是否必要 |
示例值 |
描述 |
---|---|---|---|---|
experiments |
String |
否 |
实验ID列表 格式为 experiments=urlencode([123, -2]) 如果需要查询基准数据,请加传 -2 |
|
indexes |
String |
否 |
自定义指标 格式为 indexes=urlencode(["pv", "uv"]) |
|
start |
Integer |
否 |
1582214400 |
开始时间 默认为当天0分0秒的时间戳 |
stop |
Integer |
否 |
1582646399 |
结束时间 默认为当前时间戳 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
requestId | String | D77D0DAF-790D-F5F5-A9C0-133738165014 |
请求ID |
result | Array of result |
数据报表结果 |
|
ctr | Float | 0.567 |
IPV/PV,表示结果点击次数占访问次数的比例 |
date | String | 2020-05-06 |
日期 |
experimentName | String | first_rank_v2+rank_v28 |
实验名称 |
ipv | Integer | 30362 |
ItemPageView,用户点击了搜索页中的结果的次数 |
ipvUv | Integer | 5903 |
在搜索结果页中点击了结果的用户数 |
pv | Integer | 24556 |
搜索 PV |
uv | Integer | 8184 |
搜索 UV |
zeroHitRate | Float | 0.004 |
无结果率 |
示例
请求示例
GET /v4/openapi/app-groups/lsh_test_03/scenes/20615/groups/13726/metrics?experiments=%5B-2%5D
正常返回示例
XML
格式
<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>
<result>
<experimentSerialNumber>-2</experimentSerialNumber>
<experimentName>first_rank_v2+rank_v28</experimentName>
<date>2020-05-06</date>
<pv>24556</pv>
<ipv>30362</ipv>
<uv>8184</uv>
<ipvUv>5903</ipvUv>
<ctr>0.567</ctr>
<zeroHitRate>0.004</zeroHitRate>
<queryPerUser>67</queryPerUser>
<exposuresCount>5667</exposuresCount>
<queryEffectiveCount>5567</queryEffectiveCount>
</result>
JSON
格式
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": {
"experimentSerialNumber": -2,
"experimentName": "first_rank_v2+rank_v28",
"date": "2020-05-06",
"pv": 24556,
"ipv": 30362,
"uv": 8184,
"ipvUv": 5903,
"ctr": 0.567,
"zeroHitRate": 0.004,
"queryPerUser": 67,
"exposuresCount": 5667,
"queryEffectiveCount": 5567
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交