API Explorer: /masters/{masterId}/xbt-scenarios-summary?testId={testId}

To get GUI functional scenarios summary statistics, you will need a masterId and the corresponding testId for that master. The sample code returns the scenarios summary stats for the masterId of 12345678 attached to testId of 1234567. Use the masterId and the testId of the actual master in place of 12345678 and its corresponding test in place of 1234567.

GUI Functional Scenarios Summary

curl 'https://a.blazemeter.com/api/v4/masters/12345678/xbt-scenarios-summary?testId=1234567' \
    --user 'api_key_id:api_key_secret'

All timestamps are in UNIX Epoch Time.

Attributes

• scenariosarray

  List of scenarios that ran with the GUI functional test

  Show/Hide Child Attributes

  • testSuiteUniqueAliasstring

    The unique alias for the test suite

  • testSuiteNamestring

    The name of the test suite

  • sessionsarray

    The list of the sessions that ran the scenario

    Show/Hide Child Attributes

    • browserNamestring

      The name of the browser used for this test case

    • browserVersionstring

      The browser version used for this test case

    • sessionIdstring

      The sessionId for the test case

    • sessionNamestring

      The name of the session for this test case

    • statusinteger

      The status level of the test. The value 140 indicates the test was completed

    • definedStatusstring

      Denotes if the test case passed or failed or is broken or is undefined

  • definedStatusstring

    Denotes if the test suite passed or failed or is broken or is undefined

• summaryobject

  The summary details for the GUI functional test

  Show/Hide Child Attributes

  • uniqueTestCasesCountinteger

    The unique number of test cases in this test

  • uniqueSuitesCountinteger

    The unique number of test suties in this test

  • passedTestCasesCountinteger

    The number of test cases that are in a passed state

  • failedTestCasesCountinteger

    The number of the test cases that are in a failed state

  • brokenTestCasesCountinteger

    The number of test cases that are in a broken state

  • totalTestCasesCountinteger

    The total number of test cases

  • undefinedTestCasesCountinteger

    The number of test cases that are in a undefined state

  • testCasesCountinteger

    The number of test cases in this test

  • passedPercentinteger

    The percentage of test cases that passed (1 being 100 percent)

  • startedfloat

    The timestamp for when this test began

  • endedfloat

    The timestamp for when this test ended

  • definedStatusstring

    Denotes if the test passed or failed or is broken or is undefined

  • suitesPassedinteger

    The number of test suites that passed

  • sessionsPassedinteger

    The number of sessions that passed

• uniqueLocationNamesarray

  List of unique locations used in this test

{
    "api_version": 4,
    "error": null,
    "result": {
        "scenarios": [
            {
                "testSuiteUniqueAlias": "Scenario 1-1",
                "testSuiteName": "Scenario 1",
                "sessions": [
                    {
                        "browserName": "chrome",
                        "browserVersion": "77.0.3865.120",
                        "platformName": null,
                        "platformVersion": null,
                        "sessionId": "r-sg-5ef24af96a077",
                        "testDataIterationId": null,
                        "sessionName": "chrome_77",
                        "status": 140,
                        "definedStatus": "passed"
                    }
                ],
                "definedStatus": "passed"
            }
        ],
        "summary": {
            "uniqueTestCasesCount": 1,
            "uniqueSuitesCount": 1,
            "passedTestCasesCount": 1,
            "failedTestCasesCount": 0,
            "brokenTestCasesCount": 0,
            "totalTestCasesCount": 1,
            "undefinedTestCasesCount": 0,
            "testCasesCount": 1,
            "passedPercent": 1,
            "started": 1592937232.7655351,
            "ended": 1592937251.8649161,
            "definedStatus": "passed",
            "suitesPassed": 1,
            "suitesTotal": 0,
            "sessionsPassed": 1,
            "sessionsTotal": 0
        },
        "uniqueLocationNames": [
            "US West (Oregon) - Functional GUI Test"
        ],
        "reportUrl": null
    },
    "request_id": "5ef3abb011481"
}