API Explorer: /masters/{masterId}/test-suite-summary

To get the summary details from a test suite master, a masterId is required. The sample code returns the summary details of a teset suite for the master with masterId of 12345678. Use the actaul masterId in place of 12345678.

Test Suite Summary

curl 'https://a.blazemeter.com/api/v4/masters/12345678/test-suite-summary' \
    --user 'api_key_id:api_key_secret'

All timestamps are in UNIX Epoch time.

Attributes

• testsResultarray

  The list of test results from all tests in the test suite

  Show/Hide Child Attributes

  • testIdinteger

    The unique identifier of the test. This is known as the testId and cannot be modified

  • testNamestring

    The name of the test

  • testTypestring

    The type of test. Can be either of the following:
    functionalApi - Denotes an API functional test
    functionalGui - Denote a GUI functional test

  • definedStatusstring

    Denotes if the test passed or failed, or is broken (in the case of GUI functional)

  • suitesPassedinteger

    Denotes the number of tests that passed

  • suitesTotalinteger

    Denotes the number of tests in total

  • sessionsPassedinteger

    Denotes the number of sessions that passed

  • sessionsTotalinteger

    Denotes the number of sessions in total

  • startedfloat

    The timestamp of the start time of the test

  • endedfloat

    The timestamp of the end time of the test

• uniqueLocationNamesarray

  List of all unique locations run in the test suite. These values uses the location names, not the location Ids

• suiteSummaryobject

  The summary details of the whole test suite

  Show/Hide Child Attributes

  • suitesPassedinteger

    Denotes the number of tests that passed

  • suitesTotalinteger

    Denotes the number of tests in total

  • sessionsPassedinteger

    Denotes the number of sessions that passed

  • sessionsTotalinteger

    Denotes the number of sessions in total

  • definedStatusstring

    Denotes if the test suite passed or failed, or is broken or undefined (in the case of GUI functional)

  • startedinteger

    The timestamp of the start time of the test suite

  • endedfloat

    The timestamp of the end time of the test suite

• updatedinteger

  The timestampe of the last update to the test suite summary

{
    "api_version": 4,
    "error": null,
    "result": {
        "testsResult": [
            {
                "testId": 7632610,
                "testName": "Santander Proxy GUI Functional Validation Test",
                "testType": "functionalGui",
                "definedStatus": "passed",
                "suitesPassed": 1,
                "suitesTotal": 1,
                "sessionsPassed": 1,
                "sessionsTotal": 1,
                "started": 1592939030.8151221,
                "ended": 1592939051.8028064
            },
            {
                "testId": 7895446,
                "testName": "API Functional Validation Test",
                "testType": "functionalApi",
                "definedStatus": "passed",
                "suitesPassed": 1,
                "suitesTotal": 1,
                "sessionsPassed": 1,
                "sessionsTotal": 1,
                "started": 1592938966,
                "ended": 1592939017
            }
        ],
        "uniqueLocationNames": [
            "US West (Oregon) - Functional GUI Test",
            "US West (Los Angeles) - Functional Test"
        ],
        "suiteSummary": {
            "suitesPassed": 2,
            "suitesTotal": 2,
            "sessionsPassed": 2,
            "sessionsTotal": 2,
            "definedStatus": "passed",
            "started": 1592938966,
            "ended": 1592939051.8028064
        },
        "updated": 1592939391
    },
    "request_id": "5ef36d19ac49f"
}