Existing KPIs

This Eggplant Performance Analyzer REST method is for working with existing Key Performance Indicators (KPIs). You can use the following URL with a GET HTTP method to return information about existing KPIs, or a DELETE method to delete an existing KPI. The GET method is shown first, followed by the DELETE method.

URL

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

HTTP Method

GET: Gets information about the specified KPI.

Response Parameters

Parameter	Type	Description
kpi	object	Information about the KPI.

Example Request

http://localhost:5000/analyzer/api/1.0/Workspace%201/Project%201/Series%201/Test%201/1/kpis/Max%20transaction%20rate%20should%20be%20greater%20than%2010

Example Response

{
  "kpi": {
    "bucketCount": 100,
    "category": "Transactions",
    "chartAxisSeriesType": "Timing",
    "measurementName": null,
    "name": "Max transaction rate should be greater than 10",
    "operand": ">=",
    "statType": "Rate",
    "summaryStatType": "Maximum",
    "target": 10.0
  }
}

HTTP Method

DELETE: Deletes an existing KPI.

Response Parameters

Parameter	Type	Description
<run number>	string	The URL of the test run that contained the KPI.

Example Request

http://localhost:5000/analyzer/api/1.0/Workspace%201/Project%201/Series%201/Test%201/1/kpis/Max%20transaction%20rate%20should%20be%20greater%20than%2010

Example Response

{
  "1": "http://localhost:5000/analyzer/api/1.0/Workspace%201/Project%201/Series%201/Test%201/1"
}