AuthRuleV2BacktestRetrieveParams

Returns the backtest results of an Auth rule (if available).

Backtesting is an asynchronous process that requires time to complete. If a customer retrieves the backtest results using this endpoint before the report is fully generated, the response will return null for results.current_version and results.draft_version. Customers are advised to wait for the backtest creation process to complete (as indicated by the webhook event auth_rules.backtest_report.created) before retrieving results from this endpoint.

Backtesting is an asynchronous process, while the backtest is being processed, results will not be available which will cause results.current_version and results.draft_version objects to contain null. The entries in results will also always represent the configuration of the rule at the time requests are made to this endpoint. For example, the results for current_version in the served backtest report will be consistent with which version of the rule is currently activated in the respective event stream, regardless of which version of the rule was active in the event stream at the time a backtest is requested.

Types

Link copied to clipboard
Link copied to clipboard
object Companion

Functions

Link copied to clipboard

Additional headers to send with the request.

Link copied to clipboard

Additional query param to send with the request.

Link copied to clipboard
open override fun _headers(): Headers

The full set of headers in the parameters, including both fixed and additional headers.

Link copied to clipboard
fun _pathParam(index: Int): String
Link copied to clipboard
open override fun _queryParams(): QueryParams

The full set of query params in the parameters, including both fixed and additional query params.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String