API Functional Summary Statistics
API Explorer: /masters/{masterId}/reports/functional/groups
To get the API functional summary statistics, use the masterId
. The sample code returns summary stats for the masterId
of 12345678
. Use the masterId
of the actual test run in place of 12345678
.
API Functional Summary Statistics
curl 'https://a.blazemeter.com/api/v4/masters/12345678/reports/functional/groups' \
--user 'api_key_id:api_key_secret'
API Functional Summary Statistics Parameters
Below are a list of query parameters that can be used to narrow down your search for groups in a master:
Parameters
-
filter[status]
stringProvide
pass
to see only the samples that passed andfail
to see only the samples that failed -
testId
integerThe unique identifier of the test. This is known as the
testId
and cannot be modified
API Functional Summary Statistics Response Attributes
All time values are in milliseconds (ms).
Attributes
-
groupId
stringThe
groupId
for this group of results -
sessionId
stringThe
sessionId
for this test run -
summary
objectSummary details for the test run
Show/Hide Child Attributes
-
testsCount
integerNumber of samples/requests that ran
-
requestsCount
integerNumber of samples/requests that ran
-
errorsCount
integerNumber of errors that occurred
-
assertions
objectThe assertion summary stats for this test run
Show/Hide Child Attributes
-
count
integerThe count of assertions in the test run
-
passed
integerThe count of assertions that passed
-
-
responseTime
objectThe response time stats for this test run
Show/Hide Child Attributes
-
sum
integerThe response time for the full test run
-
-
isFailed
booleanDenotes if the test failed or not
-
failedCount
integerThe number of samples/requests that failed during the test run
-
-
id
stringThe
groupId
for this group of results -
name
stringThe name of the group that is displayed in the API functional report
Response200 OK
{
"api_version": 4,
"error": null,
"result": [
{
"groupId": "76691196-ec79-5b35-a91d-2d10f8f850ad",
"sessionId": "r-v4-5e0a5d6cf08c6",
"summary": {
"testsCount": 28,
"requestsCount": 28,
"errorsCount": 7,
"assertions": {
"count": 0,
"passed": 0
},
"responseTime": {
"sum": 12552
},
"isFailed": true,
"failedCount": 7,
"failedPercentage": 100
},
"id": "76691196-ec79-5b35-a91d-2d10f8f850ad",
"name": "Thread Group 1"
}
],
"request_id": "5e0a698b1423f"
}