Queries the data quality report of an OpenSearch application.

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 common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/data-report HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.
endTime String Query Yes 1582646399

The end of the time range to query.

If you do not set this parameter, the time range to query ends at the current time.
startTime String Query Yes 1582214400

The beginning of the time range to query.

If you do not set this parameter, the time range to query starts from 00:00:00 on the current day.

Response parameters

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

The ID of the request.
result Struct

The information about the data quality report.
receivedCount Integer 100

The number of entries returned.
receivedSample Array of receivedSample

The sample data in the data quality report. The value is a JSON string.

For more information, see the "Upload behavioral data" section of the Data collection 2.0 topic.

message Struct

The information in the data quality report.
arg1 String search
arg3 String 100
args String 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
clientIp String 10.101.193.208
eventId Integer 2001
page String detail
sdkType String opensearch_sdk
sdkVersion String v3.2.0
sessionId String 10.101.193.20812345678901
userId String test_user_2
receivedTimeMs Long 1566922762148

The time when the data quality report was returned.

Examples

Sample requests

GET /v4/openapi/app-groups/daydayup/data-report?startTime=1593964800&endTime=1594051200

Sample success responses

XML format 

<requestId>D77D0DAF-790D-F5F5-A9C0-133738165014</requestId>
<result>
    <receivedCount>100</receivedCount>
    <receivedSample>[{"receivedTimeMs":1566922762148,"message":{"clientIp":"10.101.193.208","arg3":"100","userId":"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","sdkType":"opensearch_sdk","sessionId":"10.101.193.20812345678901","eventId":2001,"sdkVersion":"v3.2.0","page":"detail"}},{"receivedTimeMs":1566922762148,"message":{"bhvType":"click","bhvValue":"","bizId":123321,"rn":"reqqwerqasdfasdf123124","reachTime":123321,"itemId":"asb-123","itemType":2001,"sdkVersion":"v3.3.0"}}]</receivedSample>
</result>

JSON format 

{
    "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
    "result": {
        "receivedCount": 100,
        "receivedSample": "[{\"receivedTimeMs\":1566922762148,\"message\":{\"clientIp\":\"10.101.193.208\",\"arg3\":\"100\",\"userId\":\"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\",\"sdkType\":\"opensearch_sdk\",\"sessionId\":\"10.101.193.20812345678901\",\"eventId\":2001,\"sdkVersion\":\"v3.2.0\",\"page\":\"detail\"}},{\"receivedTimeMs\":1566922762148,\"message\":{\"bhvType\":\"click\",\"bhvValue\":\"\",\"bizId\":123321,\"rn\":\"reqqwerqasdfasdf123124\",\"reachTime\":123321,\"itemId\":\"asb-123\",\"itemType\":2001,\"sdkVersion\":\"v3.3.0\"}}]"
    }
}

Error codes

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