Scale Intelligence■ Docs
Docs / The model / Summary

Summary.

A count, share, rank or ratio in one of three positions, never folded

Figure 1Summaryspecified
SUMMARYfact at follows scopepositionenum:measured|never measure…only for measured, which may be zerovaluejsonoptionalfor never measuredreasontextoptionalwithheld_countcountoptionalcoverage[ChannelCoverage]populationPopulationStatementpredicate_versionhashdefinition_versioncountCHANNELCOVERAGEthrough coveragePOPULATIONSTATEMENTthrough population
Summary is a fact at follows scope. The drawing shows its fields and the objects that they point at.
kind
fact
scope
follows
key
the predicate, its own definition and the window
store
postgres
family
rules_engine

Fields#

fieldtyperequirednote
positionone of measured | never measured | withheldyes
valuejsonnoonly for measured, which may be zero
reasontextnofor never measured
withheld_countcountno
coverageChannelCoverageyes
populationPopulationStatementyes
predicate_versionhashyes
definition_versioncountyes

Routes that use it#

No route takes or returns Summary directly. The record holds it, and the objects that point at it reach it.