Queries statistical reports, such as application reports, drop-down suggestions reports, top searches and hints reports, A/B test reports, and data quality reports.

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]/statistic-report/[moduleName] HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes app_group_name

The name of the application.

moduleName String Path Yes suggest

The name of the module. Valid values:

  • app
  • app-query
  • abtest
  • suggest
  • hot
  • hint
  • data-quality
startTime Integer Query No 1582214400

The beginning of the time range to query.

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

endTime Integer Query No 1582646399

The end of the time range to query.

Default value: the timestamp of the current time.

pageNumber Integer Query No 1

The number of the page to return. Default value: 1.

pageSize Integer Query No 10

The number of items to return on each page. Default value: 10.

columns String Query No pv,uv

The fields to query.

Example: columns="pv,uv,ipv".

query String Query No bizType:test,sceneTag:myTag

The query conditions. Set this parameter in the format of k1:v1,k2:v2. Valid values:

  • experimentSerialNumber: the unique ID of the test.
  • sceneTag: the tag of the test scenario.
  • bizType: the tag of the business.
  • modelId: the ID of the algorithm model.

Response parameters

Parameter Type Example Description
requestId String F76ACE3D-E510-EE2C-B7B1-39B3136A61EE

The ID of the request.

result List [ { "bizType":"test" } ]

The queried reports. Valid values:

For more information about the metrics in data quality reports, see the Upload behavioral data section of Data collection 2.0.

For more information about the metrics in application and A/B test reports, see the Core metrics section of Metrics of statistical reports.

For more information about the metrics in query analysis reports, see the Query analysis metrics section of Metrics of statistical reports.

totalCount Long 1

The total number of the queried reports.

Examples

Sample requests

GET /v4/openapi/app-groups/my_app/statistic-report/app?columns=pv,uv,ipv&startTime=1591459200&quey=bizType:alibaba

Sample success responses

XML format

<requestId>F76ACE3D-E510-EE2C-B7B1-39B3136A61EE</requestId>
<result>
    <bizType>test</bizType>
</result>
<totalCount>1</totalCount>

JSON format

{
    "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
    "result": {
        "bizType": "test"
    },
    "totalCount": 1
}

More sample responses

```
Sample response for application reports:
{
    "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
    "result": [
      {
          "pv":100,
          "ctr":0.99,
          "uv":0.56,
          "ipv":0.70
      }
    ],
    "totalCount": 1
}

Sample response for data quality reports:
{
  "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
  "result": [
    {
      "receivedCount": 100,
      "receivedSample": "[{\"received_time_ms\":1566922762148,\"message\":{\"client_ip\":\"10.101.193.208\",\"arg3\":\"100\",\"user_id\":\"test_user_2\",\"args\":\"object_id=0,object_type=ops_search_doc,ops_request_misc=%7B%22request%5Fid%22%3A%22156692276120025169650670%22%2C%22scm%22%3A%2220140713.100289989..%22%7D\",\"arg1\":\"search\",\"sdk_type\":\"opensearch_sdk\",\"session_id\":\"10.101.193.20812345678901\",\"event_id\":2001,\"sdk_version\":\"v3.2.0\",\"page\":\"detail\"}},{\"received_time_ms\":1566922762148,\"message\":{\"bhv_type\":\"click\",\"bhv_value\":\"\",\"biz_id\":123321,\"rn\":\"reqqwerqasdfasdf123124\",\"reach_time\":123321,\"item_id\":\"asb-123\",\"item_type\":2001,\"sdk_version\":\"v3.3.0\"}}]"
    }
  ],
  "totalCount": 1
}

```
            

Error codes

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