Comparison Information

ThisEggplant Performance Analyzer REST method is for working with comparisons. You use the following URL with a GET HTTP method to return information about a comparison, or a DELETE HTTP method to delete a comparison. The GET method is shown first, followed by the DELETE method.

URL

/analyzer/api/1.0/comparisons/<comparison>

HTTP Method

GET: Gets information about a comparison.

Response Parameters

Parameter Type Description
add_analysis_view string The URL to use to add an analysis view to this comparison.
analysis_views object The names and URLs of all the analysis views that have been added to this comparison.
charts object The names and URLs of all the charts that have been added to this comparison.
create_comparison_chart string The URL to use to create a new comparison chart.
create_report string The URL to use to create a report for this comparison.
remove_analysis_view string The URL to use to remove an analysis view from this comparison.

Example Request

http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison

Example Response

{

"add_analysis_view": "http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison/add_analysis_view",

"analysis_views": {

"Series 1/Test 1.1/View 1": "/analyzer/api/1.0/Workspace%201/Project%201/Series%201/Test%201/1/analysis_views/View%201",

"Series 1/Test 1.1/View 2": "/analyzer/api/1.0/Workspace%201/Project%201/Series%201/Test%201/1/analysis_views/View%202"

},

"charts": {

"Transactions Response Time (95th Percentile), by Timing": "http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison/Transactions%20Response%20Time%20%2895th%20Percentile%29%2C%20by%20Timing"

},

"create_comparison_chart": "http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison/create_comparison_chart",

"create_report": "http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison/create_report",

"remove_analysis_view": "http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison/remove_analysis_view"

}

HTTP Method

DELETE: Deletes a comparison.

Response Parameters

Parameter Type Description
comparisons string The URL for getting information about existing comparisons.

Example Request

http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison

Example Response

{

"comparisons": "http://localhost:5000/analyzer/api/1.0/comparisons"

}

 

This topic was last updated on March 17, 2020, at 11:55:07 AM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2020 Eggplant