You are here:

KPIs for an Analysis View

This Eggplant Performance Analyzer REST method returns Key Performance Indicators (KPIs) for an analysis view. You use the following URL with a GET HTTP method as described here.

URL

/analyzer/api/1.0/<workspace>/<project>/<series>/<test>/<run number>/analysis_views/<view>/kpis

HTTP Method

GET: Lists KPIs for an analysis view.

Response Parameters

Parameter	Type	Description
kpis	object	Information about the KPIs for this test run.

For each KPI:

Parameter	Type	Description
KPI_name	object	Information about the KPI.

For each series in the KPI:

Parameter	Type	Description
KPI_series	object	Information about the KPI series.

For each series:

Parameter	Type	Description
actualValue	number	The actual value of the KPI in the analysis view.
expectedValue	string	The target value of the KPI.
state	string	Returns the state: "Passed" or "Failed."

Example Request

http://localhost:5000/analyzer/api/1.0/Workspace%201/Project%201/Series%201/Test%201/1/analysis_views/View%201/kpis

Example Response

{

"kpis": {

"Max transaction rate should be greater than 10": {

"<COMBINED>": {

"actualValue": 10.01,

"expectedValue": ">=10.0",

"state": "Passed"

}

"Total error count should be less than 100": {

"<COMBINED>": {

"actualValue": 872.0,

"expectedValue": ">=100.0",

"state": "Failed"

}

This topic was last updated on January 13, 2022, at 02:42:23 PM.