Get online summary data during a test run

Description

Returns online summary data during a test run.

Available in versions 2021 and later: It also returns online summary data for runs that have already finished.

URL

Copy code
/LoadTest/rest/domains/{domainName}/projects/{projectName}/runs/{runId}/onlineRunData

Remarks

The request returns data only if the test is running.

HTTP Method

GET: Returns online summary data during a test run.

Request

Headers:

Content-Type: application/xml

Accept: application/xml

Cookies:

LWSSO_COOKIE_KEY={LwssoCookie};

Request Body:

None

Copy code
GET http://<LRE_Server>/LoadTest/rest/domains/DEFAULT/projects/project1/runs/25/onlineRunData
Content-Type: application/xml
Accept: application/xml
Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes.

Upon successful retrieval, returns HTTP status 200 (OK).

HTML Body:

GET: Returns the data on the entity in the response.

Note: As of LoadRunner Enterprise 2020 SP3, the rest call was upgraded and it returns more data.

Copy code
<OnlineSummaryData>
    <PassedTransactionsNum>
           <KeyText>TotalPassedTransactions</KeyText>
           <ValueText>0</ValueText>   
    </PassedTransactionsNum>
    <FailedTransactionsNum>
           <KeyText>TotalFailedTransactions</KeyText>
           <ValueText>0</ValueText>   
    </FailedTransactionsNum>
    <TotalVusers>
           <KeyText>Total Vusers</KeyText>
           <ValueText>2</ValueText>   
    </TotalVusers>
    <NotStartedVusers>
           <KeyText>Not Started</KeyText>
           <ValueText>0</ValueText>   
    </NotStartedVusers>
    <ActiveVusers>
           <KeyText>Active</KeyText>
           <ValueText>0</ValueText>   
    </ActiveVusers>
    <FinishedVusers>
           <KeyText>Finished</KeyText>
           <ValueText>0</ValueText>   
    </FinishedVusers>
    <DownVusers>
           <KeyText>Down</KeyText>
           <ValueText>0</ValueText>   
    </DownVusers>
    <PendingVusers>
           <KeyText>Pending</KeyText>
           <ValueText>0</ValueText>   
    </PendingVusers>
    <InitVusers>
           <KeyText>Init</KeyText>
           <ValueText>0</ValueText>   
    </InitVusers>
    <ReadyVusers>
           <KeyText>Ready</KeyText>
           <ValueText>0</ValueText>   
    </ReadyVusers>
    <RunningVusers>
           <KeyText></KeyText>
           <ValueText>0</ValueText>   
    </RunningVusers>
    <RendezvousVusers>
           <KeyText>Rendezvous</KeyText>
           <ValueText>0</ValueText>   
    </RendezvousVusers>
    <GExitVusers>
           <KeyText>GExit</KeyText>
           <ValueText>0</ValueText>   
    </GExitVusers>
    <ExitVusers>
           <KeyText>Exit</KeyText>
           <ValueText>0</ValueText>   
    </ExitVusers>
    <PausedVusers>
           <KeyText>Paused</KeyText>
           <ValueText>0</ValueText>   
    </PausedVusers>
    <StoppedVusers>
           <KeyText>Stopped</KeyText>
           <ValueText>0</ValueText>   
    </StoppedVusers>
    <PassedVusers>
           <KeyText>Passed</KeyText>
           <ValueText>0</ValueText>   
    </PassedVusers>
    <FailedVusers>
           <KeyText>Failed</KeyText>
           <ValueText>0</ValueText>   
    </FailedVusers>
    <ErrorVusers>
           <KeyText>Error</KeyText>
           <ValueText>0</ValueText>   
    </ErrorVusers>
</OnlineSummaryData>
Copy code
<Run xmlns="http://www.hp.com/PC/REST/API">
    <TestID>224</TestID>
    <TestInstanceID>33</TestInstanceID>
    <PostRunAction>Do Not Collate</PostRunAction>
    <TimeslotID>3533</TimeslotID>
    <VudsMode>false</VudsMode>
    <ID>126</ID>
    <RunState>Before Collating Results</RunState> 
    <RunSLAStatus>Not Completed</RunSLAStatus>
</Run>

See Also

Runs