Skip to main content

Create a Comparison Report

This Eggplant Performance Analyzer REST method creates a report from a comparison. You use the following URL with a POST HTTP method as described here.

URL

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

HTTP Method

POST: Creates a report from a comparison.

Request Parameters

ParameterTypeDescription
pathstringThe path of the report to create.
reportTemplatestringThe name of a report template to use.
workspacestringThe name of the workspace that contains the report template to use.
projectstringThe name of the project that contains the report template to use.
formatstringThe format of the report. Possible values are pdf, odt or html.

Response Parameters

ParameterTypeDescription
reportstringThe path of the newly created report.

Example Request

http://localhost:5000/analyzer/api/1.0/comparisons/My%20Comparison/create_report
POST Data
{
"path": "C:/My Report.pdf",
"reportTemplate": "Default Report",
"workspace": "Workspace 1",
"project": "Project 1",
"format": "pdf"
}

Example Response

{
"report": "C:/My Report.pdf"
}