Queries the statistical report of a test group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/scenes/[sceneId]/groups/[groupId]/metrics HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.
groupId Integer Path Yes 13466

The ID of the test group.
sceneId Integer Path Yes 20404

The ID of the test scenario.
Request body

Parameter

Type

Required

Example

Description

experiments

String

No

The IDs of tests.

Example: experiments=urlencode([123, -2]).

If you want to query the base data, pass -2 to this parameter, as shown in the example.

indexes

String

No

The custom metrics.

Example: indexes=urlencode(["pv", "uv"]).

start

Integer

No

1582214400

The beginning of the time range to query.

Default value: the timestamp of 00:00 on the current day.

stop

Integer

No

1582646399

The end of the time range to query.

Default value: the timestamp of the current time.

Response parameters

Parameter Type Example Description
requestId String D77D0DAF-790D-F5F5-A9C0-133738165014

The ID of the request.
result Array of result

The data in the statistical report.
ctr Float 0.567

The ratio of the number of clicks to the number of views. This ratio is calculated by dividing the number of item page views (IPVs) by the number of item page views (PVs).

date String 2020-05-06

The date of the test.
experimentName String first_rank_v2+rank_v28

The name of the test.
ipv Integer 30362

The number of IPVs, which indicates the number of times search results were clicked.
ipvUv Integer 5903

The number of users who clicked search results.
pv Integer 24556

The number of PVs of all search requests.
uv Integer 8184

The number of unique visitors (UVs) of all search requests.
zeroHitRate Float 0.004

The zero-result rate of all search requests.

Examples

Sample requests

GET /v4/openapi/app-groups/lsh_test_03/scenes/20615/groups/13726/metrics?experiments=%5B-2%5D

Sample success responses

XML format 

<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 format 

{
    "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
    }
}

Error codes

For a list of error codes, visit the API Error Center.