Skip to content
Asqary Docs

Get a backtest and its summary

GET
/v1/backtest/{backtest_id}
curl --request GET \
  --url https://api-staging.asqary.com/v1/backtest/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
backtest_id
required
string
/^bt_[0-9a-f]{32}$/

Responses

Section titled “Responses”

200

Section titled “200”

The backtest

Media typeapplication/json
object
backtest_id
required
string
/^bt_[0-9a-f]{32}$/
status
required
string
Allowed values: queued running completed failed cancelled
policy
required
object
id
required
string
/^pol_[0-9a-f]{32}$/
version
required
integer
version_id
required
string
/^plv_[0-9a-f]{32}$/
config_sha256
string
engine_version
string
dataset
required
object
format
string
Allowed values: json csv
sha256
string
row_count
integer
invalid_row_count
integer
summary
required
One of:
object
scored
integer
by_risk_level
object
key
additional properties
integer
by_action
object
key
additional properties
integer
score_histogram
Array<object>
object
from
integer
to
integer
count
integer
mean_score
number
mean_confidence
number
rule_hits
object
key
additional properties
integer
labels
One of:
null
error
required
string | null
environment
required
string
Allowed values: live test
notify_emails
Array<string>
notified_at
string | null format: date-time
created_at
required
string format: date-time
started_at
string | null format: date-time
completed_at
string | null format: date-time

Example 

{
  "status": "queued",
  "dataset": {
    "format": "json"
  },
  "summary": {
    "labels": {
      "thresholds": [
        {
          "level": "low"
        }
      ]
    }
  },
  "environment": "live"
}

404

Section titled “404”

Resource or endpoint not found.

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}