Reports

Backtest Report

Introduction

Read out the report of a backtest in the project id specified

Request

A JSON object containing info about the project to delete. The /backtests/read/report API accepts requests in the following format:

BacktestReportRequest Model - Request to read out the report of a backtest.
projectId integer
Id of the project to read.
backtestId string
Specific backtest Id to read.
Example
{
  "projectId": 0,
  "backtestId": "string"
}

Responses

The /backtests/read/report API provides a response in the following format:

200 Success

BacktestReport Model - Backtest Report Response wrapper.
report string
HTML data of the report with embedded base64 images.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example
{
  "report": "string",
  "success": true,
  "errors": [
    "string"
  ]
}
RequestFailedError Model - The API method call could not be completed as requested.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example
{
  "success": true,
  "errors": [
    "string"
  ]
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: