ListStatisticReport - OpenSearch - Alibaba Cloud Documentation Center

Queries statistical reports, such as application reports, drop-down suggestion reports, hotword shading reports, A/B test reports, and data quality reports.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application	app_group_name
moduleName	string	Yes	The module name. Valid values: app: Business operation report. app-query: Business operation report> Query analysis metric. abtest: A/B test report. suggest: Drop-down suggestion report. hot: Hotword report. hint: Shading report data-quality es: Open-source compatible instance report	suggest
startTime	integer	No	The start timestamp of the query. Unit: seconds.	1582214400
endTime	integer	No	The end timestamp of the query. By default, the end time is the current time. Unit: seconds.	1582646399
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10
columns	string	No	The fields to query. Set this parameter in the format of columns="pv,uv,ipv". For more information, see Metrics of statistical reports.	pv,uv
query	string	No	The query conditions. Set this parameter in the format of k1:v1,k2:v2. Valid values: experimentSerialNumber: the globally unique sequence number of the test sceneTag: the tag of the test scenario bizType: the type of the business modelId: the ID of the algorithm model	bizType:test,sceneTag:myTag

Response parameters

Parameter	Type	Description	Example
	object	The rsponse body.
totalCount	long	The total number of entries returned.	43
requestId	string	The request ID.	F65C8BB2-C14F-5983-888B-41C4E082D3BC
result	array<object>	The statistical 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.	[]
result	object	The result body.	{}

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history