Eggplant Performance Analyzer REST API Method Summary Table

The REST API URLs and methods for working with Eggplant Performance Analyzer are listed in the following table. Use the links in the table or the menu on the right to go to the pages for the URLs. The pages provide descriptions and examples for the URLs and methods.

Note that text shown in italics like this on this and the following pages indicates values that should be replaced with those in your environment.

Title URL

HTTP

Method

Description
Element URLs and Methods
Category Statistics /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/data/category GET Lists available statistics for a category.
Project Information/ Deletion /analyzer/api/1.0/workspace/project

GET

 

DELETE

Gets information about the specified project.

Deletes information about the specified project.

Series Information /analyzer/api/1.0/workspace/project/series GET Gets information about the specified series.
Test Information /analyzer/api/1.0/workspace/project/series/test GET Gets information about the specified test.
Analysis View URLs and Methods
Analysis View Data /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/data GET Lists available data for the specified analysis view.
Analysis View Information/ Deletion /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view

GET

 

DELETE

Gets information about the specified analysis view.

Deletes the specified analysis view.

Analysis View KPIs /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/kpis GET Gets information about Key Performance Indicators (KPIs) for a specified analysis view.
Analysis View Summary /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/summary GET Gets summary information about a specified analysis view.
Analysis View Report /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/create_report POST Creates a report for the specified analysis view.
Comparison URLs and Methods
Create Comparison /analyzer/api/1.0/comparisons/comparison/create_comparison POST Creates a new comparison.
Existing Comparisons /analyzer/api/1.0/comparisons GET Gets information about existing comparisons.
Comparison Information/ Deletion /analyzer/api/1.0/comparisons/comparison/

GET

 

DELETE

Gets information about the specified comparison.

Deletes the specified comparison.

Comparison Report /analyzer/api/1.0/comparisons/comparison/create_report POST Creates a report form the specified comparison.
Comparison Analysis View Addition /analyzer/api/1.0/comparisons/comparison/add_analysis_view POST Adds an analysis view to an existing comparison.
Comparison Analysis View Removal /analyzer/api/1.0/comparisons/comparison/remove_analysis_view POST Removes an analysis view from an existing comparison.
Comparison Chart URLs and Methods
Create Comparison Chart /analyzer/api/1.0/comparisons/comparison/create_comparison_chart POST Creates a new comparison chart.
Comparison Chart Data /analyzer/api/1.0/comparisons/comparison/comparison chart

GET

 

 

 

DELETE

Gets data for a comparison chart. Note that this is all the data that would be displayed on the chart in the user interface.

Deletes the specified comparison chart.

KPI URLs and Methods
Create KPI /analyzer/api/1.0/workspace/project/series/test/run number/create_kpi POST Creates a new KPI.
KPI Information/ Deletion /analyzer/api/1.0/workspace/project/series/test/run number/kpis/kpi

GET

 

DELETE

Gets information about an existing KPI.

Deletes an existing KPI.

Series URLs and Methods
Series Data Values /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/data/category/statistic/series type/series GET Gets the data values for the given series.
Series Type Series /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/data/category/statistic/series type GET Lists available series for the specified series type.
Series Types Statistics /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views/view/data/category/statistic GET Lists available series types for a statistic.
Test Run URLs and Methods
Test Run Add SUT Data /analyzer/api/1.0/workspace/project/series/test/run number/add_sut_data POST Adds System Under Test (SUT) data to a test run.
Create Test Run Analysis View /analyzer/api/1.0/workspace/project/series/test/run number/create_analysis_view POST Creates a new analysis view for the test run.
Test Run Analysis Views /analyzer/api/1.0/workspace/project/series/test/run number/analysis_views GET Gets a list of analysis views for the specified test run.
Test Run Import (Raw) /analyzer/api/1.0/add_raw_test_run POST Imports a raw test run into the analysis database.
Test Run Information/ Deletion /analyzer/api/1.0/workspace/project/series/test/run number

GET

 

DELETE

Gets information about the specified test run.

Gets information about the injectors in the test run.

Test Run Injectors /analyzer/api/1.0/workspace/project/series/test/run number/injectors GET Gets information about the injectors in the test run.
Test Run VU Groups /analyzer/api/1.0/workspace/project/series/test/run number/vu_groups GET Gets information about the virtual user (VU) groups in the test run.
Test Run Scripts /analyzer/api/1.0/workspace/project/series/test/run_number/scripts GET Gets information about the scripts in the test run.
Test Run Summary /analyzer/api/1.0/workspace/project/series/test/run number/summary GET Gets the summary of a test run.
Version URL and Method
Version /analyzer/api/1.0/version GET Gets the currently installed version of Eggplant Performance Analyzer.
Workspace URLs and Methods
Workspaces and Comparisons /analyzer/api/1.0 GET Lists the workspaces and comparisons that are currently in the analysis database.
Workspace Information /analyzer/api/1.0/workspace GET Gets information about the specified workspace.

 

This topic was last updated on July 28, 2020, at 11:26:51 AM.

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