All Products
Search

This Product

    OpenSearch:ListStatisticReport

    Document Center

    OpenSearch:ListStatisticReport

    Last Updated:Dec 08, 2025

    Queries statistical reports, such as application, drop-down suggestion, top search hint, A/B test, and data quality reports.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    opensearch:ListStatisticReport

    *AppGroup

    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

    		 None None

    Request syntax

    GET /v4/openapi/app-groups/{appGroupIdentity}/statistic-report/{moduleName} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    appGroupIdentity

    string

    Yes

    The name of the application.

    app_group_name
    moduleName

    string

    Yes

    The name of the module. This is an enumeration. Valid values:

    • app: Operations report.

    • app-query: Operations report > Query analysis metrics.

    • abtest: A/B test report.

    • suggest: Drop-down suggestion report.

    • hot: Top search report.

    • hint: Hint report.

    • data-quality: Behavioral data. Paging parameters are not supported.

    • es: Report for an open source-compatible instance.

    suggest

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    startTime

    integer

    No

    The start timestamp, in seconds.

    1582214400
    endTime

    integer

    No

    The end timestamp, in seconds. The default value is the current timestamp.

    1582646399
    pageNumber

    integer

    No

    The page number.

    Default value: 1.

    1
    pageSize

    integer

    No

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

    10
    columns

    string

    No

    The fields to query. Specify the fields in the columns="pv,uv,ipv" format. For more information, see Metrics of statistical reports.

    pv,uv
    query

    string

    No

    The query conditions, in the k1:v1,k2:v2 format. Valid values:

    • experimentSerialNumber: the globally unique serial number of the experiment.

    • sceneTag: the tag of the scenario.

    • bizType: the business identity.

    • modelId: the ID of the algorithm model.

    bizType:test,sceneTag:myTag

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    []
    totalCount

    integer

    The total number of entries.

    43
    requestId

    string

    The request ID.

    F65C8BB2-C14F-5983-888B-41C4E082D3BC
    result

    array<object>

    The statistical reports.

    []

    object

    The result body.

    {}

    Examples

    Success response

    JSON format

    {
  "totalCount": 43,
  "requestId": "F65C8BB2-C14F-5983-888B-41C4E082D3BC",
  "result": [
    {}
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.