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, and the linked pages provide further information and examples.
Values surrounded by <angle brackets> on this page and the method information pages indicate values that you must provide according to your Eggplant Performance workspace setup (e.g. the workspace name).
If the values you provide in URL paths contain spaces or other special characters, they must be percent-encoded, e.g. /<workspace>/ would become /My%20Workspace/
Version
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Version | GET | /analyzer/api/1.0/version | Gets the currently installed version of Eggplant Performance Analyzer. |
Workspace and project information
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Workspaces and Comparisons | GET | /analyzer/api/1.0 | Lists the workspaces and comparisons that are currently in the analysis database. |
| Workspace Information | GET | /analyzer/api/1.0/<workspace> | Gets information about the specified workspace. |
| Project Information | GET | /analyzer/api/1.0/<workspace>/<project> | Gets information about the specified project. |
| Delete Project | DELETE | /analyzer/api/1.0/<workspace>/<project> | Deletes the specified project. |
| Series Information | GET | /analyzer/api/1.0/<workspace>/<project>/<series> | Gets information about the specified series. |
| Test Information | GET | /analyzer/api/1.0/<workspace>/<project>/<series>/<test> | Gets information about the specified test. |
Importing and analyzing a test run
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Test Run Import (Raw) | POST | /analyzer/api/1.0/add_raw_test_run | Imports a raw test run into the analysis database. |
| Create Test Run Analysis View | POST | /analyzer/api/1.0/<workspace>/<project>/<series>/<test>/<run number>/create_analysis_view | Creates a new analysis view for the test run. |
Test run information
To specify the test run, all of these method URLs begin with:
/analyzer/api/1.0/<workspace>/<project>/<series>/<test>/<run number>
For brevity, these have been shortened in the following table.
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Test Run Information | GET | .../<test>/<run number> | Gets information about the specified test run. |
| Delete Test Run | DELETE | .../<test>/<run number> | Deletes the specified test run. |
| Test Run Summary | GET | .../<test>/<run number>/summary | Gets the summary of a test run. |
| Add SUT Data To Test Run | POST | .../<test>/<run number>/add_sut_data | Adds System Under Test (SUT) data to a test run. |
| Test Run Analysis Views | GET | .../<test>/<run number>/analysis_views | Gets a list of analysis views for the specified test run. |
| Test Run Injectors | GET | .../<test>/<run number>/injectors | Gets information about the injectors in the test run. |
| Test Run Scripts | GET | .../<test>/<run_number>/scripts | Gets information about the scripts in the test run. |
| Test Run VU Groups | GET | .../<test>/<run number>/vu_groups | Gets information about the virtual user (VU) groups in the test run. |
Analysis view information
To specify the test run, all of these method URLs begin with:
/analyzer/api/1.0/<workspace>/<project>/<series>/<test>/<run number>/analysis_views
For brevity, these have been shortened in the following table.
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Test Run Analysis Views | GET | ...<test>/<run number>/analysis_views | Gets a list of analysis views for the specified test run. |
| Analysis View Information | GET | .../analysis_views/<view> | Gets information about the specified analysis view. |
| Delete Analysis View | DELETE | .../analysis_views/<view> | Deletes the specified analysis view. |
| Analysis View Data | GET | .../analysis_views/<view>/data | Lists available data for the specified analysis view. |
| Analysis View KPIs | GET | .../analysis_views/<view>/kpis | Gets information about Key Performance Indicators (KPIs) for a specified analysis view. |
| Analysis View Summary | GET | .../analysis_views/<view>/summary | Gets summary information about a specified analysis view. |
| Analysis View Report | POST | .../analysis_views/<view>/create_report | Creates a report for the specified analysis view. |
Analysis view statistics
To specify the analysis view, all of these method URLs begin with:
/analyzer/api/1.0/<workspace>/<project>/<series>/<test>/<run number>/analysis_views/<view>/data
For brevity, these have been shortened in the following table.
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Category Statistics | GET | .../data/<category> | Lists available statistics for a category. |
| Series Types Statistics | GET | .../data/<category>/<statistic> | Lists available series types for a statistic. |
| Series Type Series | GET | .../data/<category>/<statistic>/<series type> | Lists available series for the specified series type. |
| Series Data Values | GET | .../data/<category>/<statistic>/<series type>/<series> | Gets the data values for the given series. |
KPI information
To specify the test run, all of these method URLs begin with:
/analyzer/api/1.0/<workspace>/<project>/<series>/<test>/<run number>
For brevity, these have been shortened in the following table.
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Create KPI | POST | .../<test>/<run number>/create_kpi | Creates a new KPI. |
| KPI Information | GET | .../<test>/<run number>/kpis/<kpi> | Gets information about an existing KPI. |
| Delete KPI | DELETE | .../<test>/<run number>/kpis/<kpi> | Deletes an existing KPI. |
Comparisons
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Existing Comparisons | GET | /analyzer/api/1.0/comparisons | Gets information about existing comparisons. |
| Create Comparison | POST | /analyzer/api/1.0/comparisons/create_comparison | Creates a new comparison. |
| Comparison Information | GET | /analyzer/api/1.0/comparisons/<comparison> | Gets information about the specified comparison. |
| Delete Comparison | DELETE | /analyzer/api/1.0/comparisons/<comparison> | Deletes the specified comparison. |
| Comparison Report | POST | /analyzer/api/1.0/comparisons/<comparison>/create_report | Creates a report form the specified comparison. |
| Comparison Analysis View Addition | POST | /analyzer/api/1.0/comparisons/<comparison>/add_analysis_view | Adds an analysis view to an existing comparison. |
| Comparison Analysis View Removal | POST | /analyzer/api/1.0/comparisons/<comparison>/remove_analysis_view | Removes an analysis view from an existing comparison. |
Comparison charts
To specify the comparison, all of these method URLs begin with:
/analyzer/api/1.0/comparisons/<comparison>
For brevity, these have been shortened in the following table.
| Title | HTTP Method | URL | Description |
|---|---|---|---|
| Create Comparison Chart | POST | .../<comparison>/create_comparison_chart | Creates a new comparison chart. |
| Comparison Chart Data | GET | .../<comparison>/<comparison chart> | Gets data for a comparison chart. Note that this is all the data that would be displayed on the chart in the user interface. |
| Delete Comparison Chart | DELETE | .../<comparison>/<comparison chart> | Deletes the specified comparison chart. |