GetReportGroupTrend
Analyzes and accumulates test report values for the specified test reports.
Request Syntax
{
"numOfReports": number
,
"reportGroupArn": "string
",
"trendField": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- reportGroupArn
-
The ARN of the report group that contains the reports to analyze.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- trendField
-
The test report value to accumulate. This must be one of the following values:
- Test reports:
-
- DURATION
-
Accumulate the test run times for the specified reports.
- PASS_RATE
-
Accumulate the percentage of tests that passed for the specified test reports.
- TOTAL
-
Accumulate the total number of tests for the specified test reports.
- Code coverage reports:
-
- BRANCH_COVERAGE
-
Accumulate the branch coverage percentages for the specified test reports.
- BRANCHES_COVERED
-
Accumulate the branches covered values for the specified test reports.
- BRANCHES_MISSED
-
Accumulate the branches missed values for the specified test reports.
- LINE_COVERAGE
-
Accumulate the line coverage percentages for the specified test reports.
- LINES_COVERED
-
Accumulate the lines covered values for the specified test reports.
- LINES_MISSED
-
Accumulate the lines not covered values for the specified test reports.
Type: String
Valid Values:
PASS_RATE | DURATION | TOTAL | LINE_COVERAGE | LINES_COVERED | LINES_MISSED | BRANCH_COVERAGE | BRANCHES_COVERED | BRANCHES_MISSED
Required: Yes
- numOfReports
-
The number of reports to analyze. This operation always retrieves the most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
Response Syntax
{
"rawData": [
{
"data": "string",
"reportArn": "string"
}
],
"stats": {
"average": "string",
"max": "string",
"min": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- rawData
-
An array that contains the raw data for each report.
Type: Array of ReportWithRawData objects
- stats
-
Contains the accumulated trend data.
Type: ReportGroupTrendStats object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInputException
-
The input value that was provided is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified AWS resource cannot be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: