HEherondata
Policy Backtests

Count deals matching a backtest selection

Changed on

Return the matching count and the count retained after applying the run limit.

post/api/policy_version/{version}/backtest/count

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/policy_version/{version}/backtest/count
  • Auth
    API key in header x-api-key

Path parameters

versioninteger required

Request body

end_user_heron_idsstring[] nullable

Specific deals to run, in request order; cannot be combined with selection filters

limitinteger nullable

Deals to include, at most 4000 (default 200)

window_daysinteger nullable

How far back to look for deals; the account's configured window when omitted

window_endstring date-time nullable

Exclusive deal creation bound; requires window_start and is clamped to now when in the future

window_startstring date-time nullable

Inclusive deal creation bound; requires window_end and cannot be combined with window_days

with_policy_resultstring[] nullable

Only deals whose last policy result was one of ['failed', 'missing_data', 'passed', 'review_required']; omit for all

Response

Matching and selected deal counts

matching_deal_countinteger
selected_deal_countinteger

Changes