Docs / The model / ReadingOffered

ReadingOffered.

The estimator offered to a buyer profile in return for a contact: the model it evaluates, the drivers it asks in order, what is shown at once and after the contact, the consent it states, its page, its play and the rung a submission lands on

Figure 1ReadingOfferedspecified

ReadingOffered is a definition at brand scope. The drawing shows its fields and the objects that they point at.

kind: definition
scope: brand
key: the buyer profile and its version
store: postgres
family: market

Fields#

field	type	required	note
`name`	`text`	yes
`kind_of_buyer`	`id`	yes
`business_model`	`id`	yes
`asks`	KindOfMeasure	yes	the drivers the buyer states, in order; no more than the parameter allows
`shown_at_once`	`[text]`	yes	the outputs shown before any contact
`shown_after_contact`	`[text]`	yes
`contact_asked`	ContactKind	yes
`consent_text`	`text`	yes
`document`	`id`	yes	the estimator page, a document
`way`	WayOfGoingToMarket	yes	the row a reading offered for a contact
`play`	`id`	no
`rung`	`text`	yes	the ladder rung a submission with a contact lands on
`version`	`count`	yes
`state`	Readiness	yes

Routes that use it#

/v1/economics/offer returns it