Hanzo
OpenapiRisk

Read back one exhaustive search

Reads back one search run: every shape tried over this organisation's own history, best first, and the one that fit.

GET /v1/risk/search/{id}

Addresshttps://api.hanzo.ai/v1/risk/search/{id}
MethodGET
OperationriskSearchResult
AuthAuthorization: Bearer $HANZO_API_KEY

Reads back one search run: every shape tried over this organisation's own history, best first, and the one that fit.

A run another organisation started is simply not there — the same 404 an unknown id gives, so the read is not a probe oracle.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the run, taken from the path.

Response

StatusBodyMeaning
200riskSearchReportok

200 body — 48 fields.

FieldInTypeAlwaysDescription
donebodybooleanDone is false while the run is still going; the trials below are then the ones finished so far.
endedbodystringEnded is when it finished, RFC 3339.
eventsbodyintegerEvents is how much of this organisation's history was replayed.
fittedbodyriskModelValue
fitted.addressbodystringAddress names this value by its own content: the model's shape, the geometry seed, its position in the window, its threshold, its masses as IEEE-754 bits and…
fitted.atbodystringAt is when it was published, RFC 3339, on the server clock.
fitted.learnedbodyintegerLearned is how many events are behind the masses.
fitted.sequencebodyintegerSequence is this value's place in YOUR organisation's own history, from 1 and contiguous until retention disposes of the oldest.
fitted.shapebodystringShape NAMES the model space the masses are only meaningful against, as <family>:<digest> — the KIND of model, and that family's own digest over the feature…
fitted.warmedbodystringWarmed is how far your own event surface had been folded in when this value was published, RFC 3339.
gapbodystringGap says why the winning shape could not be fitted into an adoptable value, when it could not.
idbodystringID is the run.
refusalbodystringRefusal says why the run proves nothing, when it does.
startedbodystringStarted is when the run was accepted, RFC 3339.
trialsbodyriskTrial[]Trials is every shape tried, best first.
trials[].alertedbodyintegerAlerted is how many of those it would have raised.
trials[].curvebodynumber[]Curve is the realised alert rate over successive tenths of the history — the learning curve, which says whether the shape settled or is still moving.
trials[].fitbodynumberFit ranks the shape, smaller being better: the relative miss of the stated appetite, plus flat penalties for never warming and for saturating, plus the share…
trials[].learnedbodyintegerLearned is how many events the shape learned from during the replay.
trials[].realisedbodynumberRealised is what that appetite actually produced.
trials[].saturatedbodybooleanSaturated is whether the appetite could not be honoured by any threshold, which is a shape that alerts on nothing and reads like a quiet one.
trials[].scoredbodyintegerScored is how many it was able to score.
trials[].statedbodynumberStated is the appetite the shape was tried at.
trials[].topologybodyriskTopology
trials[].topology.blendbodynumberBlend is how much of a closing window folds into the reference: 1 replaces it outright, less makes the reference expensive to move.
trials[].topology.depthbodyintegerDepth is how deep each tree is.
trials[].topology.familybodystringFamily is the KIND of model this candidate is: halfspace is an ensemble of half-space trees whose masses are counters, and it is the family this search grid…
trials[].topology.reviewbodynumberReview is the appetite this shape was tried at.
trials[].topology.treesbodyintegerTrees is how many half-space trees the ensemble holds.
trials[].topology.windowbodyintegerWindow is how many events make one reference window.
trials[].warmbodybooleanWarm is whether the shape learned enough to have an opinion at all over this organisation's whole history.
winnerbodyriskTrial
winner.alertedbodyintegerAlerted is how many of those it would have raised.
winner.curvebodynumber[]Curve is the realised alert rate over successive tenths of the history — the learning curve, which says whether the shape settled or is still moving.
winner.fitbodynumberFit ranks the shape, smaller being better: the relative miss of the stated appetite, plus flat penalties for never warming and for saturating, plus the share…
winner.learnedbodyintegerLearned is how many events the shape learned from during the replay.
winner.realisedbodynumberRealised is what that appetite actually produced.
winner.saturatedbodybooleanSaturated is whether the appetite could not be honoured by any threshold, which is a shape that alerts on nothing and reads like a quiet one.
winner.scoredbodyintegerScored is how many it was able to score.
winner.statedbodynumberStated is the appetite the shape was tried at.
winner.topologybodyriskTopology
winner.topology.blendbodynumberBlend is how much of a closing window folds into the reference: 1 replaces it outright, less makes the reference expensive to move.
winner.topology.depthbodyintegerDepth is how deep each tree is.
winner.topology.familybodystringFamily is the KIND of model this candidate is: halfspace is an ensemble of half-space trees whose masses are counters, and it is the family this search grid…
winner.topology.reviewbodynumberReview is the appetite this shape was tried at.
winner.topology.treesbodyintegerTrees is how many half-space trees the ensemble holds.
winner.topology.windowbodyintegerWindow is how many events make one reference window.
winner.warmbodybooleanWarm is whether the shape learned enough to have an opinion at all over this organisation's whole history.

Failure carries the platform error shape — see Errors.

Examples

hanzo risk search get <id>

Risk API · All Hanzo APIs · Interactive reference

How is this guide?

On this page