oc · docs
docs / documentation

@orangecheck/insights-client


@orangecheck/insights-client / InsightsEvent

Interface: InsightsEvent

Defined in: index.ts:57

Properties

PropertyTypeDescriptionDefined in
<a id="property-actor"></a> actor?string | nullOPTIONAL bare actor id (Bitcoin address / email). The collector salted-hashes it product-scoped and discards the raw value — never stored. Omit for fully anonymous events.index.ts:71
<a id="property-eventclass"></a> eventClass?EventClassoc-me A/B/C billable-event class, when applicable.index.ts:73
<a id="property-name"></a> namestringEvent name, e.g. 'pageview' (reserved for the beacon lane), 'bip322_success', 'settlement'.index.ts:61
<a id="property-product"></a> productstringRegistry slug of the emitting product: 'me''vault'
<a id="property-props"></a> props?Record&lt;string, PropValue>Small flat bag of custom props (capped at 30 keys; non-primitive values dropped).index.ts:65
<a id="property-subtype"></a> subtype?stringFiner event subtype, e.g. a SUBTYPE_CLASS key like 'stamp_signing'.index.ts:75
<a id="property-ts"></a> ts?stringISO-8601 timestamp. Omit to let the collector stamp receipt time.index.ts:63