Augeo AI Docs
AI Server

Event catalog

Every registered SDK event, with class, version, fields, partner eligibility, and one example.

Event list

Every registered SDK event is on this page. Each entry has a class, a version, fields, partner eligibility, and one example. POST /api/send_events accepts a yes in the Partner column. A no remains a valid SDK event. Do not send a no to the partner endpoint. The profile name is augeo.partner-ingest@1. Must marks a required field. Note holds the field text. Sample is one valid payload. Regenerate this page with bun run docs:events. Do not edit this page by hand.

Index

EventClassType versionPartner
com.augeo.conversation.connectivity.lostobserved1no
com.augeo.conversation.connectivity.restoredobserved1no
com.augeo.conversation.decline.shownmeasured1no
com.augeo.conversation.error.shownmeasured1no
com.augeo.conversation.feedback.givenmeasured1no
com.augeo.conversation.handoff.acceptedmeasured1no
com.augeo.conversation.handoff.offeredmeasured1no
com.augeo.conversation.launcher.activatedmeasured1no
com.augeo.conversation.launcher.viewedmeasured1no
com.augeo.conversation.message.receivedmeasured1no
com.augeo.conversation.message.sentmeasured1no
com.augeo.conversation.prompt.selectedmeasured1no
com.augeo.conversation.sdk.loadedmeasured1no
com.augeo.conversation.session.endedmeasured1no
com.augeo.conversation.session.startedmeasured1no
com.augeo.conversation.shell.closedobserved1no
com.augeo.conversation.shell.fallbackobserved1no
com.augeo.conversation.shell.openedobserved1no
com.augeo.conversation.tool.invokedmeasured1no
com.augeo.conversation.tool.settledmeasured1no
com.augeo.conversation.turn.admission_reportedmeasured1no
com.augeo.conversation.turn.first_tokenobserved1no
com.augeo.conversation.turn.requestedmeasured1no
com.augeo.conversation.turn.settledmeasured1no
com.augeo.conversation.turn.stalledobserved1no
com.augeo.conversation.turn.startedmeasured1no
com.augeo.conversation.turn.wait_crossedobserved1no
com.augeo.engagement.cart.item.addedmeasured1yes
com.augeo.engagement.cart.item.removedmeasured1no
com.augeo.engagement.cart.item.updatedmeasured1no
com.augeo.engagement.component.loadedmeasured1no
com.augeo.engagement.item.activatedmeasured1yes
com.augeo.engagement.item.detail.viewedmeasured1yes
com.augeo.engagement.item.savedmeasured1no
com.augeo.engagement.item.unsavedmeasured1no
com.augeo.engagement.item.viewedmeasured1yes
com.augeo.engagement.redemption.completedmeasured1yes
com.augeo.engagement.redemption.startedmeasured1no
com.augeo.engagement.search.performedmeasured1yes
com.augeo.engagement.search.submittedmeasured1no
com.augeo.factory.implementation.completedmeasured1no
com.augeo.factory.implementation.errormeasured1no
com.augeo.factory.implementation.startedmeasured1no
com.augeo.factory.implementation.turnmeasured1no
com.augeo.preference.declaredmeasured1no
com.augeo.preference.quiz.shownmeasured1no
com.augeo.preference.quiz.startedmeasured1no
com.augeo.preference.quiz.step.completedmeasured1no
com.augeo.preference.quiz.step.viewedmeasured1no
com.augeo.profile.media.addedmeasured1no
com.augeo.profile.prompt.answeredmeasured1no
com.augeo.profile.reaction.changedmeasured1no
com.augeo.profile.updatedmeasured1no
com.augeo.profile.viewedobserved1no
com.augeo.recognition.givenmeasured1no
com.augeo.recognition.initiatedobserved1no
com.augeo.recognition.receivedmeasured1no
com.augeo.ui.action.pressedobserved1no
com.augeo.ui.component.renderedobserved1no
com.augeo.ui.component.viewedobserved1no
com.augeo.ui.effect.requestedobserved1no
com.augeo.ui.effect.settledobserved1no
com.augeo.ui.media.failedobserved1no
com.augeo.ui.slot.declaredobserved1no
com.augeo.ui.slot.droppedobserved1no
com.augeo.ui.slot.failedobserved1no
com.augeo.ui.slot.filledobserved1no
com.augeo.ui.slot.settledobserved1no

com.augeo.conversation.connectivity.lost

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.connectivity.lost. The client lost its connection. Connectivity is a region that changes independently of any one transport, which is why it is its own fact rather than a failure class on whatever request happened to be in flight.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/detectedByenumyes"browser-offline-event", "request-failure", "heartbeat", "stream-closed"How the loss was detected. Recorded because the signals are not equally trustworthy: a browser offline event is reliable when it fires and says nothing when it does not, so a request failure is often the only honest detector.
/pendingEffectsintegernomin 0Unresolved mutations at the moment of loss. Each one is a candidate for 'unacknowledged' rather than 'failed', because the write may already have committed.
/pendingSlotsintegernomin 0Declared slots still waiting for content at the moment of loss.
/turnInFlightbooleannoWhether a turn was streaming when connectivity dropped.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000027",
  "type": "com.augeo.conversation.connectivity.lost",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "detectedBy": "request-failure",
      "pendingEffects": 1,
      "pendingSlots": 2,
      "turnInFlight": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.connectivity.restored

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.connectivity.restored. The other half of the connectivity pair. Without it nothing can re-run on its own and the member is asked to do something they should not have to.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/autoRetriedintegernomin 0How many recoveries the layer re-ran without asking the member. Only effects whose recovery kind was auto-retry-on-reconnect are eligible; an unacknowledged effect is never re-run, because the write may have committed.
/awaitingMemberActionintegernomin 0How many recoveries still need the member after reconnection, because their recovery kind was not auto-retry-on-reconnect.
/detectedByenumyes"browser-online-event", "request-succeeded", "heartbeat", "stream-reopened"How the restoration was detected.
/outageMsintegeryesmin 0Milliseconds between the matching connectivity.lost and this event. Joins to it on correlation.causationId.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000028",
  "type": "com.augeo.conversation.connectivity.restored",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "detectedBy": "request-succeeded",
      "outageMs": 18280,
      "autoRetried": 1,
      "awaitingMemberAction": 0
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.decline.shown

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.decline.shown. The agent declined to answer and said so. This name exists so that a refusal appears in the stream as an explicit decline and never as a silent absence: a turn that produced nothing is indistinguishable from a broken turn unless the refusal is recorded as its own fact.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/alternativeOfferedbooleanyesWhether the decline came with somewhere else to go. A decline with no alternative is a dead end and should be countable as one.
/declineIdstringnoIdentifier of this decline, when the surface addresses it.
/handoffOfferedbooleannoWhether a handoff accompanied the decline, joining this to conversation.handoff.offered.
/reasonenumyes"out-of-scope", "policy", "content-filtered", "unsupported-locale", "rate-limited", "unauthorized", "unknown"Why the agent declined.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000020",
  "type": "com.augeo.conversation.decline.shown",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "reason": "out-of-scope",
      "alternativeOffered": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.error.shown

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.error.shown. A failure the MEMBER was actually shown, as one countable governed fact. Client-side drops, timeouts and render failures never reach a server, so a server-side error count and a member-experienced error count are different numbers and always will be. This is the second one.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/announcedbooleannoWhether the failure was announced to assistive technology. A visual-only error is a silent error for part of the audience, and this is the field that makes that measurable.
/blockingbooleannoWhether the member could carry on. A failed decorative slot and a failed checkout are both errors and only one of them ends the session.
/causedByNamestringnoThe registered name of the observed event that broke, for example 'com.augeo.ui.slot.failed'. correlation.causationId carries the id of that emission; this carries what it was, so a consumer reading only measured names can still partition.
/failureenumyes"offline", "unreachable", "timeout", "rate-limited", "unauthorized", "content-filtered", "cancelled", "server", "unknown"How it failed, from the shared nine-class vocabulary. The class is what drives the recovery kind, and the recovery kind is what decides whether any affordance rendered at all.
/presentationenumyes"inline", "panel", "toast", "replaced-content", "announcement-only"How the failure reached the member. A whole panel replaced by an error state and an inline notice beside one control are not the same experience.
/recoveryKindenumno"retry", "auto-retry-on-reconnect", "verify", "reauthenticate", "rephrase", "wait", "none"The recovery offered alongside the message, or 'none'. A replay renders only when the kind is 'retry' and the retry is safe; every other kind may still render its own affordance on its own handler.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000002a",
  "type": "com.augeo.conversation.error.shown",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "failure": "offline",
      "presentation": "inline",
      "recoveryKind": "auto-retry-on-reconnect",
      "causedByName": "com.augeo.conversation.connectivity.lost",
      "blocking": true,
      "announced": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.feedback.given

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.feedback.given. A member rated something in the conversation. The free-text comment is NEVER carried - only whether one exists. Member-authored prose is the single most reliable way identity leaks into an event stream, and hasFreeText is enough to route a reviewer to the system that legitimately stores it.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/hasFreeTextbooleanyesWhether the member also typed a comment. The flag travels; the text does not.
/reasonCodesarraynoCoded reasons the member selected from a fixed list.
/reasonCodes/0stringyes
/scaleenumno"thumb", "stars", "scale-5", "scale-10", "other"The rating instrument used, so a thumb and a five-point score are not averaged together.
/sentimentenumyes"positive", "negative", "neutral"The rating given.
/targetIdstringyesmin length 1The address of the rated thing, in the space named by targetKind.
/targetKindenumyes"message", "turn", "session", "item"What was rated.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000021",
  "type": "com.augeo.conversation.feedback.given",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "targetKind": "message",
      "targetId": "t",
      "sentiment": "positive",
      "hasFreeText": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.handoff.accepted

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.handoff.accepted. The member took the offered handoff. Joined to the offer through handoffId, so acceptance rate per destination is a subtraction rather than an inference.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/acceptedViaenumno"button", "link", "voice", "message"How the member accepted.
/destinationenumyes"human-agent", "support-form", "phone", "help-center", "other"Where the member was sent. Echoed so the acceptance stands alone in a warehouse.
/handoffIdstringyesmin length 1The offer being accepted, joining back to conversation.handoff.offered.
/latencyMsintegernomin 0Milliseconds from offer to acceptance. A long hesitation before accepting a handoff is a usability finding.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000001f",
  "type": "com.augeo.conversation.handoff.accepted",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "handoffId": "h",
      "destination": "human-agent"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.handoff.offered

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.handoff.offered. The agent offered to move the member elsewhere - to a human, a form, or a help surface. Emitted on the OFFER, not only on acceptance, because an offer that is never accepted is the strongest available signal that the agent gave up in the wrong place.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/destinationenumyes"human-agent", "support-form", "phone", "help-center", "other"Where the member would be sent.
/handoffIdstringyesmin length 1Identifier of this offer, joined by conversation.handoff.accepted.
/reasonCodestringnoCoded reason for the handoff. A code, never free text.
/triggerenumno"agent", "member-request", "policy", "failure", "unknown"Why the offer was made. An agent-initiated handoff and a member-requested one are opposite quality signals.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000001e",
  "type": "com.augeo.conversation.handoff.offered",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "handoffId": "h",
      "destination": "human-agent"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.launcher.activated

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.launcher.activated. The member accepted the offer of the assistant. This is the NUMERATOR of open rate: conversation.launcher.viewed is how many members were offered the assistant, and this name is how many accepted. It is not conversation.session.started (a conversation identity coming into existence) and it is not conversation.shell.opened (the chrome becoming visible).

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/activationSourceenumyes"fab", "search-field", "search-results", "deeplink", "host-api"Which affordance the member accepted. search-results records the actual contextual launch request once per client turn, causally joined to the native CTA press. It does not claim shell visibility, submission or durable admission.
/hasSeedbooleannoWhether the activation carried seed text into the composer. A seeded open and an empty one are different products.
/launcherKindenumno"persistent", "proactive-prompt", "inline-entry", "nav-item"The form of the offer that was accepted. Mirrors conversation.launcher.viewed so the open-rate join does not re-derive kind from two vocabularies.
/presentationenumno"modal", "sidebar", "embedded"The shell the activation is about to open. Distinct from shell.opened, which fires when that chrome actually becomes visible.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000031",
  "type": "com.augeo.conversation.launcher.activated",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "activationSource": "search-field",
      "launcherKind": "inline-entry",
      "presentation": "modal",
      "hasSeed": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.launcher.viewed

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.launcher.viewed. The launcher that offers the assistant met the viewability rule. This is the DENOMINATOR of open rate: the number of members who were offered the assistant, as opposed to the number who accepted.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/assistantStateenumno"closed", "minimised"Whether the assistant behind the launcher was closed, or open in a minimised form, when the launcher became viewable. Omit it for inline-entry. An already-open assistant does not make that offer illegal, and this field is not filled in to record that fact.
/exposureMsintegeryesmin 0Cumulative milliseconds the launcher was viewable when the rule was satisfied.
/launcherKindenumno"persistent", "proactive-prompt", "inline-entry", "nav-item"The form the offer took. A persistent bubble and a one-time proactive prompt convert at completely different rates and averaging them produces a number that describes neither. inline-entry is a section impression of an inline offer and does not depend on assistant shell state.
/thresholdobjectnoThe rule that made this a view, carried with the event so a later threshold change does not silently restate history.
/threshold/msintegernomin 0Minimum continuous milliseconds required.
/threshold/rationumbernomin 0, max 1Minimum intersection ratio required.
/unreadCountintegernomin 0Waiting messages advertised on the launcher, where the surface advertises any. A badged launcher is a different offer from a bare one.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000029",
  "type": "com.augeo.conversation.launcher.viewed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "exposureMs": 1204,
      "threshold": {
        "ratio": 0.5,
        "ms": 1000
      },
      "launcherKind": "persistent",
      "unreadCount": 0,
      "assistantState": "closed"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.message.received

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.message.received. The agent's message arrived for the member. Content is never carried, for the same reason it is never carried on the outbound side. What IS carried is the composition of the answer - which block kinds it used and whether it completed - because that is what explains a good or bad turn.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/blockCountintegernomin 0How many blocks the answer contained.
/blockKindsarraynoThe content blocks the answer was composed of, in order.
/blockKinds/0stringyes
/completeMsintegernomin 0Milliseconds from turn start to the last rendered token.
/firstTokenMsintegernomin 0Milliseconds from turn start to the first rendered token. The latency members actually feel.
/messageIdstringyesmin length 1Identifier of the message within the conversation.
/streamedbooleanyesWhether the message arrived incrementally. Streaming is what makes slot declaration ordering observable at all.
/truncatedbooleannoWhether the message was cut short. A truncated answer that reports as delivered is how a broken turn looks successful.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000018",
  "type": "com.augeo.conversation.message.received",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "messageId": "m",
      "streamed": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.message.sent

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.message.sent. The member sent a message to the agent. The message CONTENT is never carried - not truncated, not hashed, not sampled. What a member typed is exactly the free-text field that turns an event stream into an identity leak, so the payload carries shape and never substance.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/attachmentCountintegernomin 0How many attachments accompanied it.
/charCountintegernomin 0Length of the message in characters. Shape, not substance.
/inputMethodenumno"typed", "voice", "prompt-chip", "paste", "retry"How the member composed it. 'prompt-chip' sends are what make conversation.prompt.selected attributable to an outcome.
/isRetrybooleannoWhether the member re-sent after a failure. Retries are the clearest signal that the previous turn did not work.
/messageIdstringyesmin length 1Identifier of the message within the conversation. An address, never content.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000017",
  "type": "com.augeo.conversation.message.sent",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "messageId": "m"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.prompt.selected

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.prompt.selected. A member chose a suggested prompt rather than composing their own. The measured counterpart to the observed ui.action.pressed on the chip: the press is a gesture, this is the conversational choice, and the difference is what tells you whether suggestions are worth rendering.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/labelstringnoThe visible text of the suggestion. Agent-authored copy only.
/offeredCountintegernomin 0How many suggestions were offered alongside it. The denominator for suggestion take-rate.
/positionintegernomin 0Zero-based rank of the suggestion in the offered set.
/presentationenumno"card", "pill", "chip"How the suggestion was rendered. An opener card and an opener pill are the same conversational choice on different chrome, and averaging them produces a take-rate that describes neither.
/promptIdstringyesmin length 1Identifier of the prompt that was chosen.
/promptSourceenumyes"suggested", "starter", "agent-offered", "history"Where the suggestion came from. A starter shown before any conversation and one offered mid-turn perform very differently.
/promptTypeenumno"generated", "affordability", "comparison"Business kind of the prompt. Closed to generated, affordability and comparison. A direct projection of producer prompt.kind, not inferred from question text, provenance or shell state.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000001d",
  "type": "com.augeo.conversation.prompt.selected",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "promptId": "opener.gift-ideas",
      "promptSource": "starter",
      "presentation": "card",
      "position": 0,
      "offeredCount": 3
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.sdk.loaded

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.sdk.loaded. One successful chat SDK host-root boot on a host page, including a closed modal or sidebar and a hidden launcher. It measures availability independently of engagement. It is not conversation.shell.opened, conversation.session.started, conversation.launcher.viewed, conversation.launcher.activated, or com.augeo.engagement.component.loaded, and it is not a Theo-enabled flag. Absence does not establish disablement. Join context stays on the existing envelope: correlation.conversationId is optional, so a closed shell validates without one; participantRef, programId, and placementId stay in data.context.theo and are omitted when the host did not supply them. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/identityStatusenumyes"resolved", "unavailable"Whether the existing user query settled to an opaque participant reference. resolved means data.context.theo.participantRef carries that reference; unavailable means the reference is omitted. This field does not carry the reference, a program, a placement, or a host slug.
/presentationenumyes"inline", "modal", "sidebar"The resolved host-root layout, not whether that surface was visible. inline is the layout a chat SDK host root emits; modal and sidebar are the other resolved layouts. embedded belongs to conversation.shell.opened and is not a value here. A closed modal, a closed sidebar, or a hidden launcher still reports the layout the host resolved.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000035",
  "type": "com.augeo.conversation.sdk.loaded",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "presentation": "inline",
      "identityStatus": "resolved"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.session.ended

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.session.ended. A conversation closed. The reason is required because 'ended' without it cannot distinguish a member who got an answer from one who gave up, and those are opposite outcomes with identical durations.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/durationMsintegernomin 0Milliseconds from session start to close.
/messageCountintegernomin 0How many messages the session contained in both directions.
/reasonenumyes"member-closed", "member-reset", "idle-timeout", "handoff", "navigated-away", "error", "system-closed"Why the session ended. 'member-reset' is a new chat while the shell stays open; 'member-closed' is the chrome going away. They must not share a funnel.
/turnCountintegernomin 0How many turns the session contained.
/unresolvedEffectsintegernomin 0Mutations still unsettled when the session closed. A non-zero value means members left with saves whose outcome no layer ever resolved.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000016",
  "type": "com.augeo.conversation.session.ended",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "reason": "member-reset",
      "durationMs": 79810,
      "turnCount": 1,
      "messageCount": 2,
      "unresolvedEffects": 0
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.session.started

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.session.started. A conversation opened. The conversation identity itself is a correlation key and lives in correlation.conversationId and data.context.chatsdk, not here; this payload carries only how the session came to exist.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/channelenumno"web", "mobile-web", "ios", "android", "embedded"The surface the conversation is running on.
/entryPointstringnoWhere on the host surface the session was opened from, for example 'nav' or 'offer_card'.
/localestringnoBCP 47 locale in force at open.
/resumedbooleanyesWhether this continues prior history rather than starting empty. Resumed sessions inflate engagement if counted as new.
/startedByenumyes"member", "system", "deeplink", "handoff"What opened the session. A member-opened session and a system-opened one are different products and must not share a funnel.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000015",
  "type": "com.augeo.conversation.session.started",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "startedBy": "member",
      "resumed": false,
      "entryPoint": "reset",
      "channel": "web"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.shell.closed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.shell.closed. The chat chrome became hidden. Observed, paired with conversation.shell.opened. Not conversation.session.ended: a member can reset the conversation while the shell stays open, and a session can outlive a panel that was dismissed and later reopened.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/durationMsintegeryesmin 0Milliseconds the chrome was visible. Time-in-panel, not time-in-conversation: a reset that starts a new session does not close the shell.
/presentationenumyes"modal", "sidebar", "embedded"The chrome that became hidden.
/reasonenumyes"member-closed", "navigated-away", "system-closed"Why the chrome closed. A member dismiss and a host navigation are opposite quality signals with identical durations.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000033",
  "type": "com.augeo.conversation.shell.closed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "presentation": "modal",
      "reason": "member-closed",
      "durationMs": 199820
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.shell.fallback

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.shell.fallback. Sidebar presentation could not be mounted and the runtime degraded to a modal. Observed: it is a transport/layout fact the runtime asserts, not a member interaction and not a funnel row.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/fromconstyes"sidebar"The presentation that could not be mounted. Today only sidebar falls back.
/reasonenumyes"host-unresolved", "reflow-unsafe", "wrap-failed", "unknown"Why sidebar presentation could not be used. Closed vocabulary: the SDK's previous free-text error.message is exactly the diagnostic field BR-7 forbids on an event.
/toconstyes"modal"The presentation the runtime degraded to.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000034",
  "type": "com.augeo.conversation.shell.fallback",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "from": "sidebar",
      "to": "modal",
      "reason": "host-unresolved"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.shell.opened

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.shell.opened. The chat chrome became visible. Observed, because the runtime can assert a panel toggle with nothing declared about what the conversation means. Paired with conversation.shell.closed. Not conversation.session.started: a shell can reopen onto an existing session, and a session can start while the shell is already open.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/entryPointenumno"fab", "search-field", "deeplink", "host-api"What caused this open. Mirrors conversation.launcher.activated.activationSource when the open is the result of accepting the launcher offer.
/hasExistingSessionbooleannoWhether a conversation was already in progress behind the chrome. True on reopen; false on a first open. This is the field that stops shell.opened being counted as a new session.
/presentationenumyes"modal", "sidebar", "embedded"The chrome that became visible. A modal overlay, a docked sidebar and an embedded island are different surfaces even when they host the same conversation.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000032",
  "type": "com.augeo.conversation.shell.opened",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "presentation": "modal",
      "entryPoint": "search-field",
      "hasExistingSession": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.tool.invoked

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.tool.invoked. The agent called a tool. Paired with conversation.tool.settled through invocationId, which is what makes a tool that was called and never answered visible instead of merely slow.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/argCountintegernomin 0How many arguments were supplied. Shape of the call, never its values.
/invocationIdstringyesmin length 1Identifier of this call, joined by conversation.tool.settled. Not the envelope id: one invocation produces two emissions.
/parallelIndexintegernomin 0Position within a parallel tool batch, when the agent fanned out.
/toolNamestringyesmin length 1The tool the agent called, for example 'search_offers'.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000001b",
  "type": "com.augeo.conversation.tool.invoked",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "toolName": "t",
      "invocationId": "i"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.tool.settled

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.tool.settled. A tool call reached a terminal phase. It reuses EffectPhase rather than SlotPhase because a tool call is a request with an answer, not a region of content: 'unacknowledged' is a real outcome here and 'empty' is not.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/durationMsintegernomin 0Milliseconds from invocation to settlement.
/failureobjectnoPresent when phase is 'rejected'. Mirrors AugeoInteractionState.failure.
/failure/classenumyes"offline", "unreachable", "timeout", "rate-limited", "unauthorized", "content-filtered", "cancelled", "server", "unknown"How a slot or an effect failed. Nine classes. The class drives the recovery kind, and the recovery kind drives whether any affordance renders at all.
/failure/detailstringyesDiagnostic detail for logs and debugging. Not member-facing.
/failure/messagestringyesMember-facing copy. Subject to the BR-7 allowlist: never carries identity.
/invocationIdstringyesmin length 1The invocation this settles, joining back to conversation.tool.invoked.
/phaseenumyes"confirmed", "rejected", "unacknowledged"The terminal EffectPhase the call reached.
/recoveryobjectnoWhat the member was offered next. A replay renders ONLY when kind is 'retry' AND retrySafe is true; any other kind may render its own action, never on the retry handler. Optional attempt and exits travel with it.
/recovery/attemptintegernomin 1Which try this recovery describes, counting from one. Written by the fold owner; a component must not mint it.
/recovery/exitsarraynoWays out that are not a replay. Only report and leave. The design system renders an exit only when this list names it.
/recovery/exits/0enumyes"report", "leave"
/recovery/kindenumyes"retry", "auto-retry-on-reconnect", "verify", "reauthenticate", "rephrase", "wait", "none"What the member can actually do next. Seven kinds. A replay renders ONLY when kind is 'retry' AND recovery.retrySafe is true; every other kind may still render its own affordance, on a separate handler, never the retry handler. An 'unacknowledged' effect NEVER offers 'retry' because the mutation may have committed - its recovery is 'verify'.
/recovery/retrySafebooleanyesWhether replaying the mutation is safe. Must be false whenever the phase is 'unacknowledged'.
/resultCountintegernomin 0How many results came back. Zero results is a successful call and an empty answer.
/resultKindenumno"data", "render", "none"What the tool produced. A tool that confirmed with 'none' answered successfully and gave the member nothing, which is a distinct and important outcome.
/toolNamestringyesmin length 1The tool that settled, echoing conversation.tool.invoked.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000001c",
  "type": "com.augeo.conversation.tool.settled",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "toolName": "t",
      "invocationId": "i",
      "phase": "confirmed"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.admission_reported

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.admission_reported. The outcome of accepted selected-turn processing. status admitted, with a user message and a created or existing disposition, is proven admission. status rejected, failed or uncertain, with a closed code, is not admission. Unavailability is a code, not a fifth status. This is not conversation.handoff.accepted and not conversation.turn.started.

Fields

Paths are JSON pointers into the occurrence.

Each block is one valid shape.

status is "admitted"

PathTypeMustRulesNote
/dispositionenumyes"created", "existing"Whether admission created the thread message or joined an existing one.
/offeredCountintegeryesmin 1Displayed full-set length of the selected set. At least one.
/positionintegeryesmin 0Zero-based rank of the suggestion in the offered set.
/presentationenumyes"card", "pill", "chip"How the suggestion was rendered. An opener card and an opener pill are the same conversational choice on different chrome, and averaging them produces a take-rate that describes neither.
/promptIdstringyesmin length 1Identifier of the prompt that was chosen.
/promptSourceenumyes"suggested", "starter", "agent-offered", "history"Where the suggestion came from. A starter shown before any conversation and one offered mid-turn perform very differently.
/promptTypeenumyes"generated", "affordability", "comparison"Business kind of the prompt. Closed to generated, affordability and comparison. A direct projection of producer prompt.kind, not inferred from question text, provenance or shell state.
/statusconstyes"admitted"The selected turn was admitted. Proven admission, not a request and not a dispatch.
/userMessageIdstringyesThe admitted user message, as a UUID. Distinct from this event id and from causationId.

status is "rejected"

PathTypeMustRulesNote
/codeenumyes"invalid_context", "unsupported_context", "ineligible", "eligibility_unavailable", "identity_changed", "disposed", "open_failed", "cancelled", "thread_unavailable", "thread_scope_mismatch", "context_conflict", "session_unavailable", "product_unavailable", "admission_denied", "queue_full", "transport_failed", "admission_unknown"Why a selected turn was not admitted. Closed. Unavailability is one of these codes, not another status. An unknown code fails until this vocabulary itself changes.
/offeredCountintegeryesmin 1Displayed full-set length of the selected set. At least one.
/positionintegeryesmin 0Zero-based rank of the suggestion in the offered set.
/presentationenumyes"card", "pill", "chip"How the suggestion was rendered. An opener card and an opener pill are the same conversational choice on different chrome, and averaging them produces a take-rate that describes neither.
/promptIdstringyesmin length 1Identifier of the prompt that was chosen.
/promptSourceenumyes"suggested", "starter", "agent-offered", "history"Where the suggestion came from. A starter shown before any conversation and one offered mid-turn perform very differently.
/promptTypeenumyes"generated", "affordability", "comparison"Business kind of the prompt. Closed to generated, affordability and comparison. A direct projection of producer prompt.kind, not inferred from question text, provenance or shell state.
/statusconstyes"rejected"Processing was refused. The selected turn was not admitted.

status is "failed"

PathTypeMustRulesNote
/codeenumyes"invalid_context", "unsupported_context", "ineligible", "eligibility_unavailable", "identity_changed", "disposed", "open_failed", "cancelled", "thread_unavailable", "thread_scope_mismatch", "context_conflict", "session_unavailable", "product_unavailable", "admission_denied", "queue_full", "transport_failed", "admission_unknown"Why a selected turn was not admitted. Closed. Unavailability is one of these codes, not another status. An unknown code fails until this vocabulary itself changes.
/offeredCountintegeryesmin 1Displayed full-set length of the selected set. At least one.
/positionintegeryesmin 0Zero-based rank of the suggestion in the offered set.
/presentationenumyes"card", "pill", "chip"How the suggestion was rendered. An opener card and an opener pill are the same conversational choice on different chrome, and averaging them produces a take-rate that describes neither.
/promptIdstringyesmin length 1Identifier of the prompt that was chosen.
/promptSourceenumyes"suggested", "starter", "agent-offered", "history"Where the suggestion came from. A starter shown before any conversation and one offered mid-turn perform very differently.
/promptTypeenumyes"generated", "affordability", "comparison"Business kind of the prompt. Closed to generated, affordability and comparison. A direct projection of producer prompt.kind, not inferred from question text, provenance or shell state.
/statusconstyes"failed"Processing failed. Admission was not established.

status is "uncertain"

PathTypeMustRulesNote
/codeenumyes"invalid_context", "unsupported_context", "ineligible", "eligibility_unavailable", "identity_changed", "disposed", "open_failed", "cancelled", "thread_unavailable", "thread_scope_mismatch", "context_conflict", "session_unavailable", "product_unavailable", "admission_denied", "queue_full", "transport_failed", "admission_unknown"Why a selected turn was not admitted. Closed. Unavailability is one of these codes, not another status. An unknown code fails until this vocabulary itself changes.
/offeredCountintegeryesmin 1Displayed full-set length of the selected set. At least one.
/positionintegeryesmin 0Zero-based rank of the suggestion in the offered set.
/presentationenumyes"card", "pill", "chip"How the suggestion was rendered. An opener card and an opener pill are the same conversational choice on different chrome, and averaging them produces a take-rate that describes neither.
/promptIdstringyesmin length 1Identifier of the prompt that was chosen.
/promptSourceenumyes"suggested", "starter", "agent-offered", "history"Where the suggestion came from. A starter shown before any conversation and one offered mid-turn perform very differently.
/promptTypeenumyes"generated", "affordability", "comparison"Business kind of the prompt. Closed to generated, affordability and comparison. A direct projection of producer prompt.kind, not inferred from question text, provenance or shell state.
/statusconstyes"uncertain"Admission is unresolved. A later admitted fact may reconcile it. This status is not itself a failure.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000039",
  "type": "com.augeo.conversation.turn.admission_reported",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "promptId": "generated-2",
      "promptSource": "suggested",
      "position": 1,
      "offeredCount": 5,
      "presentation": "chip",
      "promptType": "generated",
      "status": "admitted",
      "userMessageId": "c8b4e1d6-2a70-4f93-9e15-3d6a8c0b7e42",
      "disposition": "created"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.first_token

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.first_token. The first token of a turn's response reached the member. Neither a start nor a settlement: turn.started records that the request left, turn.settled records how it ended, and the moment the member stops looking at an empty panel is between the two.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/firstTokenMsintegeryesmin 0Milliseconds from turn start to the first token rendered. Measured to the render, not to the byte arriving, because the member cannot see a buffer.
/indicatorShownbooleannoWhether a waiting indicator was on screen when the first token landed. A turn fast enough to need no indicator is a different experience from one that needed one and got there.
/streamIdstringnoThe stream this token arrived on, where the runtime distinguishes several. Joins to data.context.chatsdk.streamId.
/waitBucketenumno"instant", "brief", "noticeable", "extended"The coarse bucket firstTokenMs fell into, recorded so a later threshold change does not silently restate history.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000024",
  "type": "com.augeo.conversation.turn.first_token",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "firstTokenMs": 740,
      "waitBucket": "brief",
      "streamId": "stream_0009a",
      "indicatorShown": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.requested

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.requested. A selected prompt was accepted for processing. This is accepted processing, not dispatch and not admission: no turn has been admitted, and opening, submitting or settling a promise does not make this fact true. The payload is the six selected-prompt fields at their generic bounds. Turn, thread and causation identities stay on the envelope.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/offeredCountintegeryesmin 1Displayed full-set length of the selected set. At least one.
/positionintegeryesmin 0Zero-based rank of the suggestion in the offered set.
/presentationenumyes"card", "pill", "chip"How the suggestion was rendered. An opener card and an opener pill are the same conversational choice on different chrome, and averaging them produces a take-rate that describes neither.
/promptIdstringyesmin length 1Identifier of the prompt that was chosen.
/promptSourceenumyes"suggested", "starter", "agent-offered", "history"Where the suggestion came from. A starter shown before any conversation and one offered mid-turn perform very differently.
/promptTypeenumyes"generated", "affordability", "comparison"Business kind of the prompt. Closed to generated, affordability and comparison. A direct projection of producer prompt.kind, not inferred from question text, provenance or shell state.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000038",
  "type": "com.augeo.conversation.turn.requested",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "promptId": "generated-2",
      "promptSource": "suggested",
      "position": 1,
      "offeredCount": 5,
      "presentation": "chip",
      "promptType": "generated"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.settled

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.settled. A turn finished. It deliberately carries NO turn phase: turn phase is a projection over the turn's slots, never a stored enum, so this payload reports the slot tallies the projection is computed from and lets the reader derive the verdict.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/durationMsintegernomin 0Milliseconds from turn start to termination.
/endedByenumyes"stream-closed", "bound-expired", "cancelled", "error", "handoff"What terminated the turn. Slot bounds are evaluated on stream close, so this is the clock the slot terminations hang off.
/slotsDeclaredintegeryesmin 0How many slots the turn declared. The denominator for every fill-rate measure on this turn.
/slotsDroppedintegernomin 0How many 'decorative' slots terminated unfilled. Enrichment that never arrived, which is not a failure.
/slotsFailedintegernomin 0How many 'requested' slots terminated unfilled. Content the member asked for and did not get.
/slotsFilledintegernomin 0How many declared slots received content.
/toolInvocationsintegernomin 0How many tools the turn invoked.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000001a",
  "type": "com.augeo.conversation.turn.settled",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "endedBy": "stream-closed",
      "slotsDeclared": 3,
      "slotsFilled": 2,
      "slotsFailed": 0,
      "slotsDropped": 1,
      "durationMs": 6020,
      "toolInvocations": 2
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.stalled

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.stalled. A stream that had opened has gone quiet without closing. Distinct from a turn that failed, which closed with a reason, and from a turn still legitimately working, which is still producing tokens.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/elapsedMsintegernomin 0Milliseconds since turn start, so a stall early in a turn is separable from one near its end.
/firstTokenSeenbooleannoWhether the turn had produced its first token before going quiet. A stall before first token is a connection problem; a stall after it is a generation problem.
/quietMsintegeryesmin 0Milliseconds since the last token arrived. The threshold that made this a stall is policy and lives in the implementation layer, which is why the elapsed value travels rather than a boolean.
/streamIdstringnoThe stream that went quiet. Joins to data.context.chatsdk.streamId.
/tokensReceivedintegernomin 0How much of the response had already rendered. Zero means the member has seen nothing at all.
/waitBucketenumno"instant", "brief", "noticeable", "extended"The bucket the total wait had reached when the stall was recognised.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000025",
  "type": "com.augeo.conversation.turn.stalled",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "quietMs": 5100,
      "elapsedMs": 9880,
      "tokensReceived": 84,
      "firstTokenSeen": true,
      "waitBucket": "extended",
      "streamId": "stream_0009a"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.started

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.started. A turn opened. The turn identity is a correlation key and lives in correlation.turnId; this payload carries what triggered the turn, which is what separates member-driven work from system-driven work in every downstream cost and quality measure.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/triggerenumyes"member-message", "prompt-chip", "system", "retry", "handoff"What opened the turn.
/turnIndexintegernomin 0Zero-based position of this turn within the conversation.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000019",
  "type": "com.augeo.conversation.turn.started",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "trigger": "member-message"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.conversation.turn.wait_crossed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.conversation.turn.wait_crossed. An unresolved turn crossed a WaitBucket boundary. Emitting the crossing is what makes escalation copy auditable rather than a timer nobody outside the component can see.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/elapsedMsintegeryesmin 0Milliseconds waited when the boundary was crossed. The threshold that produced the crossing, as applied on this surface.
/escalatedbooleannoWhether the crossing changed what the member was shown. A boundary crossed with no visible consequence is still worth recording and is not the same event.
/fromBucketenumno"instant", "brief", "noticeable", "extended"The bucket left behind. Absent on the first crossing of a wait.
/toBucketenumyes"instant", "brief", "noticeable", "extended"The bucket now in force.
/waitingOnenumno"first-token", "stream", "tool", "slot", "effect", "unknown"What the turn is waiting for, as a coarse category rather than a free-text explanation.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000026",
  "type": "com.augeo.conversation.turn.wait_crossed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "fromBucket": "brief",
      "toBucket": "noticeable",
      "elapsedMs": 4010,
      "escalated": true,
      "waitingOn": "stream"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.cart.item.added

FieldValue
Classmeasured
Type version1
Partneryes

data.occurrence for com.augeo.engagement.cart.item.added. A member asked for an item to be added to the cart. A WRITE, and therefore a request: the real cart line id, the recalculated totals and any split-tender detail are host facts and come back on the ack in outcome.data. A component that painted the item as in-cart before that ack is optimistic, and only the resolved state may confirm it.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/itemobjectyesThe item being added. quantity is the amount added.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoThe list the add was initiated from. Projects to GA4 item_list_id.
/positionintegernomin 0Zero-based rank of the item within that list.

Sample

Complete partner request.

{
  "application": "rewardshub",
  "client": "encore-values",
  "environment": "uat",
  "user_id": "member-88231",
  "events": [
    {
      "id": "6d0a3f44-9e53-4c12-b14a-3f8e1d5a7c92",
      "type": "cart.item.added",
      "time": "2026-11-17T15:04:00.000Z",
      "data": {
        "item": {
          "kind": "reward",
          "id": "offer-1842",
          "quantity": 1
        },
        "listId": "featured",
        "position": 2
      }
    }
  ]
}

com.augeo.engagement.cart.item.removed

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.cart.item.removed. A member asked for an item to be removed from the cart. A WRITE, symmetrical with engagement.cart.item.added and settled the same way - by the host's ack, never by the component.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/itemobjectyesThe item being removed. quantity is the amount removed.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/reasonenumno"member", "unavailable", "expired", "replaced", "unknown"Why it was removed, when the surface knows. A member-initiated removal and a system eviction are not the same signal.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000011",
  "type": "com.augeo.engagement.cart.item.removed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "item": {
        "kind": "k",
        "id": "i"
      }
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.cart.item.updated

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.cart.item.updated. A member asked for an existing cart line to change - usually its quantity, sometimes its variant. A WRITE, settled by the host's ack. Kept as its own name rather than folded into an add or a remove, because collapsing an update into either one loses the fact that the member adjusted rather than reconsidered.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/itemobjectyesThe cart line after the requested change. quantity is the requested NEW quantity.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/previousQuantityintegeryesmin 0The quantity the line held before the request, as the component rendered it. The delta against item.quantity is what the GA4 projection reads.
/previousVariantIdstringnoThe variant the line held before the request, when the update changed variant rather than quantity.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000012",
  "type": "com.augeo.engagement.cart.item.updated",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "item": {
        "kind": "k",
        "id": "i"
      },
      "previousQuantity": 0
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.component.loaded

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.component.loaded. A component finished loading a list of catalogue things that the composing feature declared to be commercially meaningful. This is the measured counterpart to ui.component.rendered: the mechanical render always happens, this only happens when the feature said what the component means.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/componentNamestringyesmin length 1The component that loaded the list, for example 'ProductCard' or 'OfferCard'.
/itemsarrayyesThe items that loaded, in rendered order. Projects to the GA4 items array.
/items/0objectyesAn opaque reference to a catalogue thing - a product, an offer, a voucher, a reward - as the emitting component knows it. Shared by every item, cart and redemption occurrence. It deliberately carries no price, no program, no participant and no campaign: a component knows which item it rendered, not what the ledger charged for it. Host-authoritative values (real cart line id, transaction ref, recalculated balance) ride back on the ack in outcome.data and context.<host>.
/items/0/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/items/0/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/items/0/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/items/0/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/items/0/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoStable identifier of the list. Projects to GA4 item_list_id.
/listNamestringnoHuman-readable list name. Projects to GA4 item_list_name.
/requestedCountintegernomin 0How many items were asked for. A gap against items.length is an under-fill and is only visible if the ask is recorded.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000000b",
  "type": "com.augeo.engagement.component.loaded",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "componentName": "c",
      "items": [
        {
          "kind": "k",
          "id": "i"
        }
      ]
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.item.activated

FieldValue
Classmeasured
Type version1
Partneryes

data.occurrence for com.augeo.engagement.item.activated. A member acted on a specific catalogue item - opened it, expanded it, or navigated to it. A READ with intent, not a mutation: nothing is committed, so no ack resolves it.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/activationenumyes"open", "expand", "navigate", "select", "preview"What activating it did. Distinguishes an in-place expand from a departure off the surface.
/itemobjectyesThe item the member activated.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoThe list the item was activated from. Projects to GA4 item_list_id.
/positionintegernomin 0Zero-based rank of the item within that list. Projects to GA4 index.

Sample

Complete partner request.

{
  "application": "rewardshub",
  "client": "encore-values",
  "environment": "uat",
  "user_id": "member-88231",
  "events": [
    {
      "id": "5c9f2e33-8d42-4b01-a039-2e7d0c4f6b81",
      "type": "item.activated",
      "time": "2026-11-17T15:04:00.000Z",
      "data": {
        "item": {
          "kind": "reward",
          "id": "offer-1842"
        },
        "activation": "open",
        "listId": "featured",
        "position": 2
      }
    }
  ]
}

com.augeo.engagement.item.detail.viewed

FieldValue
Classmeasured
Type version1
Partneryes

data.occurrence for com.augeo.engagement.item.detail.viewed. A member opened an item and its detail rendered. A different fact from engagement.item.viewed, which is a per-item impression inside a list.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/entryPointenumno"card-activation", "deeplink", "search-result", "agent-recommendation", "cart", "restored-session"What brought the member here. A detail reached from a deeplink has no preceding impression to attribute to, and treating it as though it did overstates list performance.
/itemobjectyesThe item whose detail rendered.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoThe list the activation came from, where there was one. Projects to GA4 item_list_id and is what joins a detail view back to the impression that earned it.
/partialbooleannoWhether the detail rendered without some of its content, for example a description that arrived and imagery that did not.
/positionintegernomin 0Zero-based rank the item held in that list. Projects to GA4 index.
/renderMsintegernomin 0Milliseconds from the activation to the detail being rendered. The distribution of this number is where a click that felt broken shows up.

Sample

Complete partner request.

{
  "application": "rewardshub",
  "client": "encore-values",
  "environment": "uat",
  "user_id": "member-88231",
  "events": [
    {
      "id": "4b8e1d22-7c31-4a90-9f28-1d6c9b3e5a70",
      "type": "item.detail.viewed",
      "time": "2026-11-17T15:04:00.000Z",
      "data": {
        "item": {
          "kind": "reward",
          "id": "offer-1842"
        },
        "entryPoint": "card-activation",
        "listId": "featured",
        "position": 2
      }
    }
  ]
}

com.augeo.engagement.item.saved

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.item.saved. A member asked for an item to be kept. This is a WRITE, so it is a request and not a settlement: the host answers with an augeo.ack and the resolved EffectPhase comes back down. The saved-entry id the host mints rides back in ack.outcome.data, because no layer above the host can know it.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/itemobjectyesThe item the member asked to save.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoThe list the item was saved from. Projects to GA4 item_list_id.
/positionintegernomin 0Zero-based rank of the item within that list.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000000e",
  "type": "com.augeo.engagement.item.saved",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "item": {
        "kind": "product",
        "id": "prd_60417",
        "attributes": {
          "displayName": "Northwind Coffee $25 eGift"
        }
      },
      "listId": "wishlist",
      "position": 2
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.item.unsaved

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.item.unsaved. A member asked for a previously kept item to be released. A WRITE, symmetrical with engagement.item.saved and settled the same way - by an ack, never by the component.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/itemobjectyesThe item the member asked to release.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoThe list the item was released from.
/positionintegernomin 0Zero-based rank of the item within that list.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000000f",
  "type": "com.augeo.engagement.item.unsaved",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "item": {
        "kind": "k",
        "id": "i"
      }
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.item.viewed

FieldValue
Classmeasured
Type version1
Partneryes

data.occurrence for com.augeo.engagement.item.viewed. A single catalogue item met the viewability rule while rendered by a component the composing feature declared commercially meaningful. Billable and attributable, unlike the observed ui.component.viewed that mechanically preceded it.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/exposureMsintegernomin 0Cumulative milliseconds the item was viewable when the rule was satisfied.
/itemobjectyesThe item that was viewed.
/item/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/item/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/item/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/item/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/item/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/listIdstringnoThe list the item was viewed within. Projects to GA4 item_list_id.
/positionintegernomin 0Zero-based rank of the item within that list. Projects to GA4 index.

Sample

Complete partner request.

{
  "application": "rewardshub",
  "client": "encore-values",
  "environment": "uat",
  "user_id": "member-88231",
  "events": [
    {
      "id": "3f2a9c1e-6b40-4d8a-9e17-0c5b8a2d4f61",
      "type": "item.viewed",
      "time": "2026-11-17T15:04:00.000Z",
      "data": {
        "item": {
          "kind": "reward",
          "id": "offer-1842"
        },
        "listId": "featured",
        "position": 2,
        "exposureMs": 1200
      }
    }
  ]
}

com.augeo.engagement.redemption.completed

FieldValue
Classmeasured
Type version1
Partneryes

data.occurrence for com.augeo.engagement.redemption.completed. A redemption reached a committed outcome. This name may only be emitted on the strength of a fulfilled augeo.ack - the layer holding the network call is the only one that knows a debit happened, so a component may never emit this on its own optimism.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/durationMsintegernomin 0Milliseconds from engagement.redemption.started to this commitment.
/itemsarrayyesThe items actually committed, which may be a subset of those that started. Projects to the GA4 items array.
/items/0objectyesAn opaque reference to a catalogue thing - a product, an offer, a voucher, a reward - as the emitting component knows it. Shared by every item, cart and redemption occurrence. It deliberately carries no price, no program, no participant and no campaign: a component knows which item it rendered, not what the ledger charged for it. Host-authoritative values (real cart line id, transaction ref, recalculated balance) ride back on the ack in outcome.data and context.<host>.
/items/0/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/items/0/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/items/0/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/items/0/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/items/0/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/partialbooleannoWhether some requested items did not commit. True means the per-item results on the ack are the authoritative record and this event alone is not.
/redemptionKindenumno"points", "cash", "split-tender", "voucher", "unknown"How value was spent.
/valueBandstringnoBanded value of the committed redemption, never a precise amount (BR-7).

Sample

Complete partner request.

{
  "application": "rewardshub",
  "client": "encore-values",
  "environment": "uat",
  "user_id": "member-88231",
  "events": [
    {
      "id": "a81d0e47-5c92-4b16-a3f8-2d7e9b0c4a15",
      "type": "com.augeo.engagement.redemption.completed",
      "time": "2026-11-17T15:04:00.000Z",
      "data": {
        "items": [
          {
            "kind": "reward",
            "id": "offer-1842",
            "quantity": 1
          }
        ],
        "redemptionKind": "points",
        "valueBand": "1000-4999"
      },
      "user_id": "member-99102"
    }
  ]
}

com.augeo.engagement.redemption.started

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.redemption.started. A member entered the flow that spends value on a set of items. The intent, not the commitment: nothing has been debited, and engagement.redemption.completed is a separate name precisely so an abandoned redemption is visible instead of implied.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/entryPointstringnoWhere the member started from, for example 'cart' or 'card'. Distinguishes a considered checkout from a one-tap redeem.
/itemsarrayyesThe items entering redemption. Projects to the GA4 items array.
/items/0objectyesAn opaque reference to a catalogue thing - a product, an offer, a voucher, a reward - as the emitting component knows it. Shared by every item, cart and redemption occurrence. It deliberately carries no price, no program, no participant and no campaign: a component knows which item it rendered, not what the ledger charged for it. Host-authoritative values (real cart line id, transaction ref, recalculated balance) ride back on the ack in outcome.data and context.<host>.
/items/0/attributesobjectnoOpen map of presentation-level attributes the component honestly knows about the item it rendered - displayed category, displayed tier, badge, sort key. Subject to the BR-7 allowlist: no emails, names, employee IDs or card references, ever.
/items/0/idstringyesmin length 1The catalogue identifier of the item as rendered. Never a member identifier, never a card reference.
/items/0/kindstringyesmin length 1What sort of thing this is, in the emitting catalogue's own words - for example 'product', 'offer', 'voucher', 'reward'. Open on purpose: the registry does not own the host's catalogue taxonomy.
/items/0/quantityintegernomin 0How many units this reference stands for. Absent means the count is not meaningful for this occurrence.
/items/0/variantIdstringnoThe specific variant rendered, when the item has variants (size, tier, denomination).
/redemptionKindenumno"points", "cash", "split-tender", "voucher", "unknown"How value is being spent. 'split-tender' is called out because its per-tender amounts are host facts that only the ack can supply.
/valueBandstringnoBanded value of the redemption as displayed, never a precise amount (BR-7). Absent when the surface has no displayed value to band.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000013",
  "type": "com.augeo.engagement.redemption.started",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "items": [
        {
          "kind": "k",
          "id": "i"
        }
      ]
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.engagement.search.performed

FieldValue
Classmeasured
Type version1
Partneryes

data.occurrence for com.augeo.engagement.search.performed. A member executed a search from the search bar and a results state was presented. That covers submitting typed text and selecting a typeahead suggestion. keyword is the executed term. It does not fire for keystrokes, suggestion fetching without a selection, agent or LLM searches, a failed or cancelled request, a result that was never presented, or pagination and re-render of an already executed search. A presented empty-results state is outcome empty with resultCount 0. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

Each block is one valid shape.

outcome is "success"

PathTypeMustRulesNote
/categoryIdstringnomin length 1Opaque catalogue-category code that filtered the executed search. Omitted when the search was not filtered by category. A code, never member-authored text.
/keywordstringyesmin length 1, max length 200The search term the member executed by submitting typed text or selecting a typeahead suggestion. Not the earlier keystroke prefix, and not an agent or LLM query.
/outcomeconstyes"success"The presented page contained result items.
/pageintegeryesmin 1The presented result page, counting from 1. Pagination of an already executed search is not a new search.
/productTypestringnomin length 1Nonempty code from the emitting catalogue's taxonomy that filtered the executed search. Omitted when the search was not filtered by product type.
/resultCountintegeryesmin 1How many result items were presented on that page.

outcome is "empty", resultCount is 0

PathTypeMustRulesNote
/categoryIdstringnomin length 1Opaque catalogue-category code that filtered the executed search. Omitted when the search was not filtered by category. A code, never member-authored text.
/keywordstringyesmin length 1, max length 200The search term the member executed by submitting typed text or selecting a typeahead suggestion. Not the earlier keystroke prefix, and not an agent or LLM query.
/outcomeconstyes"empty"The presented page is an empty-results state.
/pageintegeryesmin 1The presented result page, counting from 1. Pagination of an already executed search is not a new search.
/productTypestringnomin length 1Nonempty code from the emitting catalogue's taxonomy that filtered the executed search. Omitted when the search was not filtered by product type.
/resultCountconstyes0No result items were presented on that page.

Sample

Complete partner request.

{
  "application": "rewardshub",
  "client": "encore-values",
  "environment": "uat",
  "user_id": "member-88231",
  "events": [
    {
      "id": "7c1e4b90-2a55-4f63-8d01-9e6a3c5b7d82",
      "type": "search.performed",
      "time": "2026-11-17T15:04:00.000Z",
      "data": {
        "keyword": "coffee",
        "outcome": "success",
        "page": 1,
        "resultCount": 24
      }
    }
  ]
}

com.augeo.engagement.search.submitted

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.engagement.search.submitted. The search widget accepted a deliberate member search from typed text or a selected catalogue suggestion. The SDK emits once at submission, before delegating execution to a host, without waiting for results. It does not fire for keystrokes, suggestion fetching without a selection, Ask AI, product activation, retries, pagination, or re-render. A later failed or cancelled request does not undo the submission. Result presentation remains a separate search.performed fact. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/categoryIdstringnomin length 1Opaque catalogue-category code that filtered the executed search. Omitted when the search was not filtered by category. A code, never member-authored text.
/keywordstringyesmin length 1, max length 200The search term the member executed by submitting typed text or selecting a typeahead suggestion. Not the earlier keystroke prefix, and not an agent or LLM query.
/productTypestringnomin length 1Nonempty code from the emitting catalogue's taxonomy that filtered the executed search. Omitted when the search was not filtered by product type.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000037",
  "type": "com.augeo.engagement.search.submitted",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "keyword": "coffee makers",
      "categoryId": "cat_beverages",
      "productType": "reward"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.factory.implementation.completed

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.factory.implementation.completed. A Product Factory implement run finished. outcome is an optional open string. Token counts, model, and costUsd are the run-level rollup when known, not a sum of turn events added to that rollup. Omission is unknown, not zero. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/actorIdstringyesRaw unprefixed Jira account id or GitHub login. The jira: or github: prefix lives on data.context.theo.participantRef. Not a name and not an email.
/actorSourceenumyes"jira", "github"Identity provider of the kickoff user. jira or github.
/branchstringnoHead or implement branch, when known.
/cacheReadTokensintegernomin 0Cache-read tokens, once plumbed through the harness usage record. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/cacheWriteTokensintegernomin 0Cache-write tokens, once plumbed through the harness usage record. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/codingEngineconstyes"harness"Coding engine for the run. harness only. OpenCode and other engines are outside this contract.
/componentstringnoFirst Jira component on the ticket, when present.
/costUsdnumbernomin 0Run-level cost in USD on completed and error. Omitted when unknown, not synthesized as zero.
/inputTokensintegernomin 0Input tokens. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/issueKeystringyesJira issue key from the implement run.
/modelstringnoharness.model_id on a turn. Primary or last model on a completed or error run. Omitted when unknown.
/outcomestringnoRun outcome, when known. An open string. Omitted rather than invented.
/outputTokensintegernomin 0Output tokens. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/personastringyesFactory run persona.
/prNumberintegernoPull request number, once known.
/projectKeystringnoJira project key, supplied by Jira or derived from issueKey.
/repoNamestringyesName of the target repository.
/repoOwnerstringyesOwner of the target repository.
/runIdstringyesFactory run id. Producers set source.instanceId to this same value.
/traceIdstringyesHarness or OpenTelemetry trace id for the run.
/triggerSourcestringyesOriginating FactoryEvent.source. jira, github, or another source string.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000042",
  "type": "com.augeo.factory.implementation.completed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "issueKey": "AIA-2901",
      "runId": "run_e17a01",
      "traceId": "4bf9e17a01c0d4a2",
      "codingEngine": "harness",
      "triggerSource": "jira",
      "actorSource": "jira",
      "actorId": "acct_e17a01",
      "repoOwner": "Kigo-Digital",
      "repoName": "augeo-events",
      "branch": "aia-2901-factory-events",
      "prNumber": 17,
      "projectKey": "AIA",
      "component": "events",
      "persona": "implementer",
      "inputTokens": 4800,
      "outputTokens": 1100,
      "cacheReadTokens": 900,
      "cacheWriteTokens": 40,
      "costUsd": 0.042,
      "model": "model_harness_01",
      "outcome": "landed"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.factory.implementation.error

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.factory.implementation.error. A Product Factory implement run ended in error. outcome, errorType, and errorReason are required. errorReason is a short reason, not a raw payload. Token counts, model, and costUsd are the run-level rollup when known. Omission is unknown, not zero. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/actorIdstringyesRaw unprefixed Jira account id or GitHub login. The jira: or github: prefix lives on data.context.theo.participantRef. Not a name and not an email.
/actorSourceenumyes"jira", "github"Identity provider of the kickoff user. jira or github.
/branchstringnoHead or implement branch, when known.
/cacheReadTokensintegernomin 0Cache-read tokens, once plumbed through the harness usage record. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/cacheWriteTokensintegernomin 0Cache-write tokens, once plumbed through the harness usage record. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/codingEngineconstyes"harness"Coding engine for the run. harness only. OpenCode and other engines are outside this contract.
/componentstringnoFirst Jira component on the ticket, when present.
/costUsdnumbernomin 0Run-level cost in USD on completed and error. Omitted when unknown, not synthesized as zero.
/errorReasonstringyesShort reason for the error. Not a raw message, tool payload, stack, name, or email.
/errorTypestringyesError class or type from session end.
/inputTokensintegernomin 0Input tokens. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/issueKeystringyesJira issue key from the implement run.
/modelstringnoharness.model_id on a turn. Primary or last model on a completed or error run. Omitted when unknown.
/outcomestringyesRun outcome. Required when the run ends in error. An open string, not an enum.
/outputTokensintegernomin 0Output tokens. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/personastringyesFactory run persona.
/prNumberintegernoPull request number, once known.
/projectKeystringnoJira project key, supplied by Jira or derived from issueKey.
/repoNamestringyesName of the target repository.
/repoOwnerstringyesOwner of the target repository.
/runIdstringyesFactory run id. Producers set source.instanceId to this same value.
/traceIdstringyesHarness or OpenTelemetry trace id for the run.
/triggerSourcestringyesOriginating FactoryEvent.source. jira, github, or another source string.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000043",
  "type": "com.augeo.factory.implementation.error",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "issueKey": "AIA-2901",
      "runId": "run_e17a01",
      "traceId": "4bf9e17a01c0d4a2",
      "codingEngine": "harness",
      "triggerSource": "jira",
      "actorSource": "jira",
      "actorId": "acct_e17a01",
      "repoOwner": "Kigo-Digital",
      "repoName": "augeo-events",
      "persona": "implementer",
      "inputTokens": 900,
      "outputTokens": 40,
      "cacheReadTokens": 12,
      "cacheWriteTokens": 4,
      "costUsd": 0.004,
      "model": "model_harness_01",
      "outcome": "failed",
      "errorType": "SessionError",
      "errorReason": "session ended before commit"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.factory.implementation.started

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.factory.implementation.started. A Product Factory implement run has started. It carries the common run scalars only. It has no turn index, token counts, cost, outcome, or error. Optional branch, pull request number, project key, and component are omitted until known. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/actorIdstringyesRaw unprefixed Jira account id or GitHub login. The jira: or github: prefix lives on data.context.theo.participantRef. Not a name and not an email.
/actorSourceenumyes"jira", "github"Identity provider of the kickoff user. jira or github.
/branchstringnoHead or implement branch, when known.
/codingEngineconstyes"harness"Coding engine for the run. harness only. OpenCode and other engines are outside this contract.
/componentstringnoFirst Jira component on the ticket, when present.
/issueKeystringyesJira issue key from the implement run.
/personastringyesFactory run persona.
/prNumberintegernoPull request number, once known.
/projectKeystringnoJira project key, supplied by Jira or derived from issueKey.
/repoNamestringyesName of the target repository.
/repoOwnerstringyesOwner of the target repository.
/runIdstringyesFactory run id. Producers set source.instanceId to this same value.
/traceIdstringyesHarness or OpenTelemetry trace id for the run.
/triggerSourcestringyesOriginating FactoryEvent.source. jira, github, or another source string.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000040",
  "type": "com.augeo.factory.implementation.started",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "issueKey": "AIA-2901",
      "runId": "run_e17a01",
      "traceId": "4bf9e17a01c0d4a2",
      "codingEngine": "harness",
      "triggerSource": "jira",
      "actorSource": "jira",
      "actorId": "acct_e17a01",
      "repoOwner": "Kigo-Digital",
      "repoName": "augeo-events",
      "persona": "implementer"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.factory.implementation.turn

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.factory.implementation.turn. One harness LLM call in a Product Factory implement run. turnIndex is the 1-based call index. Token counts, model, and latencyMs are that call when known, not a run rollup. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/actorIdstringyesRaw unprefixed Jira account id or GitHub login. The jira: or github: prefix lives on data.context.theo.participantRef. Not a name and not an email.
/actorSourceenumyes"jira", "github"Identity provider of the kickoff user. jira or github.
/branchstringnoHead or implement branch, when known.
/cacheReadTokensintegernomin 0Cache-read tokens, once plumbed through the harness usage record. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/cacheWriteTokensintegernomin 0Cache-write tokens, once plumbed through the harness usage record. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/codingEngineconstyes"harness"Coding engine for the run. harness only. OpenCode and other engines are outside this contract.
/componentstringnoFirst Jira component on the ticket, when present.
/inputTokensintegernomin 0Input tokens. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/issueKeystringyesJira issue key from the implement run.
/latencyMsnumbernomin 0LLM-call latency in milliseconds. Omitted when unknown, not synthesized as zero.
/modelstringnoharness.model_id on a turn. Primary or last model on a completed or error run. Omitted when unknown.
/outputTokensintegernomin 0Output tokens. Per-call usage on a turn, and a run-level rollup on completed and error. Omitted when unknown, not synthesized as zero. Do not add turn counts to a rollup that already includes them.
/personastringyesFactory run persona.
/prNumberintegernoPull request number, once known.
/projectKeystringnoJira project key, supplied by Jira or derived from issueKey.
/repoNamestringyesName of the target repository.
/repoOwnerstringyesOwner of the target repository.
/runIdstringyesFactory run id. Producers set source.instanceId to this same value.
/traceIdstringyesHarness or OpenTelemetry trace id for the run.
/triggerSourcestringyesOriginating FactoryEvent.source. jira, github, or another source string.
/turnIndexintegeryesmin 11-based LLM-call index in the run.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000041",
  "type": "com.augeo.factory.implementation.turn",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "issueKey": "AIA-2901",
      "runId": "run_e17a01",
      "traceId": "4bf9e17a01c0d4a2",
      "codingEngine": "harness",
      "triggerSource": "jira",
      "actorSource": "jira",
      "actorId": "acct_e17a01",
      "repoOwner": "Kigo-Digital",
      "repoName": "augeo-events",
      "persona": "implementer",
      "turnIndex": 1,
      "inputTokens": 1204,
      "outputTokens": 318,
      "cacheReadTokens": 80,
      "cacheWriteTokens": 16,
      "model": "model_harness_01",
      "latencyMs": 842.5
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.preference.declared

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.preference.declared. A member stated a preference about themselves. Explicit and declared, never inferred from behaviour, which is what separates this family from engagement.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/declaredViaenumyes"quiz", "preference-centre", "onboarding", "agent-conversation", "import"What the member was using when they declared. The same fact arriving from a quiz and from a preference centre is the same fact, and this is the field that keeps them distinguishable without needing two names.
/labelCountintegernomin 0The length of labels[], carried explicitly so a projection that flattens the array to a count does not have to reconstruct it.
/labelsarrayyesThe declared labels, as coded ids from the named taxonomy. Never free text.
/labels/0objectyes
/labels/0/idstringyesmin length 1The label id within the taxonomy.
/labels/0/rankintegernomin 0Zero-based order, where the step ranked its options.
/labels/0/weightnumbernomin 0, max 1Relative strength, where the step that produced it ranked or scored rather than simply selecting.
/operationenumno"replace", "add", "remove", "clear"How this declaration relates to what the member had declared before. A replace that is read as an add turns a changed mind into an accumulating profile.
/quizIdstringnoThe quiz that produced the declaration, when declaredVia is 'quiz'. Absent otherwise, and absent is correct rather than empty.
/stepKeystringnoThe step that produced the declaration, when one did. A run emits one declaration per answering step rather than one at the end, so a member who abandons halfway has still told us something.
/taxonomystringyesmin length 1The governed vocabulary the labels come from, for example 'interests.v2'. Without it a label id means nothing outside the system that minted it.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000030",
  "type": "com.augeo.preference.declared",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "taxonomy": "interests.v2",
      "labels": [
        {
          "id": "int_dining",
          "rank": 0
        },
        {
          "id": "int_travel",
          "rank": 1
        },
        {
          "id": "int_wellness",
          "rank": 2
        }
      ],
      "labelCount": 3,
      "declaredVia": "quiz",
      "operation": "replace",
      "quizId": "quiz_interests",
      "stepKey": "categories"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.preference.quiz.shown

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.preference.quiz.shown. A preference quiz was offered to a member and met the viewability rule. The denominator for quiz impression rate and for skip rate.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/alreadyDeclaredbooleannoWhether this member already has declared preferences in the quiz's taxonomy. Re-offering a quiz to somebody who has answered it is a different impression and should not dilute first-time rates.
/exposureMsintegeryesmin 0Cumulative milliseconds the offer was viewable when the rule was satisfied.
/quizIdstringyesmin length 1The quiz definition offered. Opaque and never a member reference.
/quizVersionintegernomin 1The version of that definition. A quiz whose questions changed is not the same quiz, and a completion rate computed across the change is two numbers averaged.
/stepCountintegernomin 1How many steps the offer commits the member to. The single strongest predictor of whether they start it.
/thresholdobjectnoThe rule that made this a view, carried with the event so a later threshold change does not silently restate history.
/threshold/msintegernomin 0Minimum continuous milliseconds required.
/threshold/rationumbernomin 0, max 1Minimum intersection ratio required.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000002c",
  "type": "com.augeo.preference.quiz.shown",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "quizId": "quiz_interests",
      "quizVersion": 2,
      "exposureMs": 1512,
      "threshold": {
        "ratio": 0.5,
        "ms": 1000
      },
      "stepCount": 3,
      "alreadyDeclared": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.preference.quiz.started

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.preference.quiz.started. The member entered the quiz flow. Separating this from quiz.shown is what makes a skip rate mean anything.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/entryPointenumno"activity-card", "preference-centre", "onboarding", "agent-prompt", "deeplink", "email"Where the run began. The same quiz entered from an onboarding page and from a card inside an assistant conversation completes at different rates.
/quizIdstringyesmin length 1The quiz definition entered.
/quizVersionintegernomin 1The version of that definition.
/resumedbooleannoWhether this continues an abandoned run rather than beginning a new one. A resumption counted as a start inflates entries and deflates completion.
/stepCountintegeryesmin 1How many steps the run has. The denominator every per-step abandonment measure divides by.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000002d",
  "type": "com.augeo.preference.quiz.started",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "quizId": "quiz_interests",
      "quizVersion": 2,
      "stepCount": 3,
      "entryPoint": "activity-card",
      "resumed": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.preference.quiz.step.completed

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.preference.quiz.step.completed. The member advanced past a step. Where members abandon, and whether the step they left behind was answered or skipped.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/dwellMsintegernomin 0Milliseconds between the step being viewed and being advanced past. A step answered instantly and one that took a minute are different signals about the question.
/isLastStepbooleannoWhether this completed the run. There is no separate quiz.completed name: the last declaration in a run is the completion, and a second name for it would be a second thing to disagree about.
/quizIdstringyesmin length 1The quiz definition this step belongs to.
/quizVersionintegernomin 1The version of that definition.
/selectionCountintegernomin 0How many options were selected. A count rather than the selections themselves: the values ride on preference.declared.
/skippedbooleanyesWhether the step was advanced past with nothing selected. Required, because a skipped step and an answered step are the two outcomes this event exists to separate, and an optional field would be absent exactly when it mattered.
/stepIndexintegeryesmin 0Zero-based position of the step advanced past.
/stepKeystringyesmin length 1Stable identifier of the step.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000002f",
  "type": "com.augeo.preference.quiz.step.completed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "quizId": "quiz_interests",
      "quizVersion": 2,
      "stepIndex": 0,
      "stepKey": "categories",
      "skipped": false,
      "selectionCount": 3,
      "dwellMs": 6810,
      "isLastStep": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.preference.quiz.step.viewed

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.preference.quiz.step.viewed. A step of the quiz was presented to the member. This is the name that identifies the step somebody was sitting on when they left.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/optionCountintegernomin 0How many options the step presented.
/quizIdstringyesmin length 1The quiz definition this step belongs to.
/quizVersionintegernomin 1The version of that definition.
/revisitbooleannoWhether the member had already seen this step in this run, for example after going back. A revisit is not a new step view.
/stepIndexintegeryesmin 0Zero-based position of the step in the run.
/stepKeystringyesmin length 1Stable identifier of the step, so a funnel survives the step order changing. Index answers where; key answers which.
/stepKindenumno"single-select", "multi-select", "rank", "scale", "free-choice-from-list", "confirm"The shape of the question, which is what makes drop-off comparable across quizzes.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000002e",
  "type": "com.augeo.preference.quiz.step.viewed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "quizId": "quiz_interests",
      "quizVersion": 2,
      "stepIndex": 0,
      "stepKey": "categories",
      "stepKind": "multi-select",
      "optionCount": 8,
      "revisit": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.profile.media.added

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.profile.media.added. The member added or removed one movie, television show, book, or music title, and the write has committed. The occurrence names the shelf and add or remove. It does not carry the title. A later optional field is free. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/operationenumyes"add", "remove"Whether the member added a title to the shelf or removed one. The title does not travel.
/shelfenumyes"movies", "tv", "books", "music"The shelf the member changed. movies, tv, books, or music. tv is television shows.
/sourceIdstringnomin length 1Opaque id of the title at that provider. Not the title.
/sourceProviderstringnomin length 1Opaque provider code for the title, when the shelf has one. Not a name.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000003b",
  "type": "com.augeo.profile.media.added",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "shelf": "movies",
      "operation": "add",
      "sourceId": "title_01"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.profile.prompt.answered

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.profile.prompt.answered. The owner answered or cleared one Fun Facts prompt, and the write has committed. The occurrence carries the prompt id and set or clear. It does not carry the answer text. A later optional field is free. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/operationenumyes"set", "clear"Whether the owner saved an answer or cleared it. The answer text does not travel.
/promptIdstringyesmin length 1Opaque id of the Fun Facts prompt. An id, never the question and never the answer.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000003c",
  "type": "com.augeo.profile.prompt.answered",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "promptId": "fun_fact_01",
      "operation": "clear"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.profile.reaction.changed

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.profile.reaction.changed. A colleague added or removed a reaction on a Fun Facts answer, and the write has committed. The occurrence carries the prompt id, whether the reaction was added or removed, and the emoji as a code. It does not carry the answer text. A later optional field is free. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/emojiCodestringyesProduct-defined emoji code: lowercase letters or digits, with single underscores between segments, such as thumbs_up. A code, never a glyph and never the answer text.
/operationenumyes"add", "remove"Whether the colleague added the reaction or removed it.
/promptIdstringyesmin length 1Opaque id of the Fun Facts answer the reaction changed. An id, never the answer text.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000003d",
  "type": "com.augeo.profile.reaction.changed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "promptId": "fun_fact_01",
      "operation": "add",
      "emojiCode": "thumbs_up"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.profile.updated

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.profile.updated. The owner saved or cleared one profile field that is not a call to action, and the write has committed. The call to actions are separate names: recognition.given, profile.media.added, profile.prompt.answered, and profile.reaction.changed. This occurrence names the field and set or clear. It does not carry the saved text, the photo, or the chip labels. A later optional field is free. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

Each block is one valid shape.

Variant 1

PathTypeMustRulesNote
/fieldenumyes"pronouns", "pitch", "about", "photo", "value_compass"An owner field that is not a call to action. pronouns, pitch, about, photo, and value_compass. value_compass is the saved compass result. The value does not travel.
/operationenumyes"set", "clear"Whether the committed write saved a value or cleared the field. The value itself does not travel.

field is "chips"

PathTypeMustRulesNote
/fieldconstyes"chips"The chip selection. shelfId is present only when the change is scoped to one shelf. Chip labels do not travel.
/operationenumyes"set", "clear"Whether the committed write saved a value or cleared the field. The value itself does not travel.
/shelfIdstringnomin length 1Opaque id of one chip shelf. Absent means the whole chip selection. An id, never a label.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000003a",
  "type": "com.augeo.profile.updated",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "field": "about",
      "operation": "set"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.profile.viewed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.profile.viewed. A profile was presented. It fires once when the profile is shown, not once per widget and not for a section impression. relation is self when the viewer owns the presented profile and peer when they do not. One name covers both. It does not wait for a committed write. It does not carry a display name, a photo, or bio text. profileRef is an optional opaque participant reference of the profile that was shown, the same kind of reference as counterpartRef on recognition.given. A profile is not a catalogue item: this is not engagement.item.viewed and not engagement.item.detail.viewed. A later optional field is free. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/profileRefstringnoOPAQUE reference to the participant whose profile was shown. Same allowlist as theo.participantRef: not a name, not an email, not an employee ID.
/relationenumyes"self", "peer"Whether the viewer owns the presented profile. self is the owner. peer is someone else.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000003e",
  "type": "com.augeo.profile.viewed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "relation": "peer",
      "profileRef": "pref_7ce20b19"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.recognition.given

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.recognition.given. The giver's side of a recognition. Recognition is DIRECTIONAL: one act produces two emissions with two actors, and each actor's emission is separately governed because the two sides are not interchangeable. This one is paired to its counterpart through correlation.interactionId (BR-4), which is the only key that joins them - never a participant identifier.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/actorRoleconstyes"giver"Always 'giver' for this name. Carried in the occurrence rather than inferred from the type, so a consumer reading a mixed stream never has to parse names to know which side it is holding.
/counterpartRefstringnoOPAQUE reference to the receiving participant. Same allowlist as theo.participantRef: not a name, not an email, not an employee ID.
/hasMessagebooleanyesWhether the giver wrote a citation. The flag travels; the text never does.
/reasonCodestringnoCoded program reason, for example a value or behaviour the program tracks. A code, never free text.
/recipientCountintegernomin 1How many receivers this act covered. A group recognition produces one 'given' and several 'received', all sharing one interactionId.
/recognitionKindenumyes"peer", "manager", "milestone", "nomination", "award"What sort of recognition was given.
/valueBandstringnoBanded value attached to the recognition, never a precise amount (BR-7). Absent when the recognition carries no value.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000022",
  "type": "com.augeo.recognition.given",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "actorRole": "giver",
      "recognitionKind": "peer",
      "hasMessage": true,
      "counterpartRef": "pref_7ce20b19",
      "recipientCount": 1,
      "valueBand": "band_100_500",
      "reasonCode": "value_above_beyond"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.recognition.initiated

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.recognition.initiated. The member opened the recognition composer from a profile. It fires when the composer opens, not for a keystroke, not for a close with no send, and not for the send. The send stays on recognition.given and recognition.received. origin is profile. entry is overview or shoutouts, the two controls that open the composer. It does not wait for a committed write. It does not carry the message. counterpartRef is an optional opaque participant reference of the profile participant. A later optional field is free. There is no default destination projection.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/counterpartRefstringnoOPAQUE reference to the profile participant. Same allowlist as theo.participantRef: not a name, not an email, not an employee ID.
/entryenumyes"overview", "shoutouts"Which profile control opened the composer. overview or shoutouts.
/originconstyes"profile"Where the composer was opened from. Always profile for this name.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000003f",
  "type": "com.augeo.recognition.initiated",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "origin": "profile",
      "entry": "overview",
      "counterpartRef": "pref_7ce20b19"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.recognition.received

FieldValue
Classmeasured
Type version1
Partnerno

data.occurrence for com.augeo.recognition.received. The receiver's side of a recognition. It is a separate emission rather than a field on the giver's event because the two actors experience the act at different times, on different surfaces, under different consent - and collapsing them into one row makes the receiver's experience unmeasurable. Paired to the giving side through correlation.interactionId (BR-4).

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/acknowledgedbooleannoWhether the receiver has seen it. Recognition that was given and never seen is the failure mode this whole directional split exists to make visible.
/actorRoleconstyes"receiver"Always 'receiver' for this name. Carried in the occurrence rather than inferred from the type, so a consumer reading a mixed stream never has to parse names to know which side it is holding.
/counterpartRefstringnoOPAQUE reference to the giving participant. Same allowlist as theo.participantRef.
/hasMessagebooleanyesWhether a citation accompanied it. The flag travels; the text never does.
/reasonCodestringnoCoded program reason. A code, never free text.
/recognitionKindenumyes"peer", "manager", "milestone", "nomination", "award"What sort of recognition was received.
/valueBandstringnoBanded value attached to the recognition, never a precise amount (BR-7).

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000023",
  "type": "com.augeo.recognition.received",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "measured",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "actorRole": "receiver",
      "recognitionKind": "peer",
      "hasMessage": true,
      "counterpartRef": "pref_3a91c40e",
      "valueBand": "band_100_500",
      "reasonCode": "value_above_beyond",
      "acknowledged": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.action.pressed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.action.pressed. A member activated a control. This is the gesture, not its consequence: if the press initiates a mutation, the mutation is reported separately by ui.effect.requested, and the outcome comes back down as an ack and a resolved state. A press that never became an effect is exactly the signal that finds a broken affordance.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/actionIdstringyesmin length 1Stable identifier of the control within its component, for example 'save' or 'view_details'.
/actionKindenumyes"button", "link", "chip", "toggle", "menuitem", "tab", "card"What sort of control it was. Drives whether a press is expected to navigate, toggle or mutate.
/inputMethodenumno"pointer", "keyboard", "touch", "assistive", "programmatic"How the control was activated. 'assistive' presses are the accessibility signal that keyboard and screen-reader paths actually work.
/labelstringnoThe visible or accessible label of the control at press time. Copy, never member data.
/toggleStateenumno"on", "off"For a toggle, the state the control moved INTO as rendered. It is a UI reading and not a confirmation - only an ack confirms.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000002",
  "type": "com.augeo.ui.action.pressed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "actionId": "favorite_button",
      "actionKind": "toggle",
      "label": "Add to favorites",
      "inputMethod": "pointer",
      "toggleState": "off"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.component.rendered

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.component.rendered. A component instance committed to the DOM. This is a mechanical fact and is always emitted, whether or not the composing feature declared what the component means - which is exactly why a Button emitting only observed names is not a gap.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/componentNamestringyesmin length 1The design system component that rendered, for example 'ProductCard' or 'BalanceBlock'.
/contentStateenumno"skeleton", "partial", "full", "error", "empty"What the component actually painted. A skeleton is a render, and reporting it as a full render is how loading time disappears from the record.
/itemCountintegernomin 0How many items the component painted, when it renders a collection.
/renderReasonenumno"initial", "update", "remount", "hydrate"Why this render happened. Separates first paint from churn.
/variantstringnoThe rendered variant, when the component has variants.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000000",
  "type": "com.augeo.ui.component.rendered",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "componentName": "offer_card",
      "variant": "rail",
      "renderReason": "initial",
      "contentState": "full",
      "itemCount": 1
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.component.viewed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.component.viewed. A component instance met the viewability threshold. Observed and component-scoped: it says a thing was on screen, not that the thing meant anything commercially. The measured counterpart for a monetizable item is engagement.item.viewed.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/componentNamestringyesmin length 1The design system component that became viewable.
/exposureMsintegeryesmin 0Cumulative milliseconds the instance was viewable when the threshold was crossed.
/occludedbooleannoWhether the instance was known to be visually obscured while nominally intersecting.
/thresholdobjectnoThe rule that made this a view. Recorded with the event so a later threshold change does not silently restate history.
/threshold/msintegernomin 0Minimum continuous milliseconds required.
/threshold/rationumbernomin 0, max 1Minimum intersection ratio required.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000001",
  "type": "com.augeo.ui.component.viewed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "componentName": "chat_launcher",
      "exposureMs": 1204,
      "threshold": {
        "ratio": 0.5,
        "ms": 1000
      },
      "occluded": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.effect.requested

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.effect.requested. A member initiated a mutation and the component asked the layer above to commit it. The component is REQUESTING, not deciding: it cannot resolve its own state, because only the layer holding the network call knows whether the mutation was acknowledged.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/boundMsintegernomin 0The deadline after which the WAITING layer mints an 'unacknowledged' outcome. A deadline expiring is not an answer.
/effectKindstringyesmin length 1The component-local name of the mutation being requested, for example 'save' or 'redeem'. Open on purpose: the design system does not own the host's mutation taxonomy, and the measured meaning is carried by the engagement family instead.
/idempotencyKeystringnoKey the host may use to collapse duplicate commits of the same intent. Distinct from AugeoEvent.id, which is delivery dedupe, and from gestureKey, which is member-gesture grouping.
/optimisticbooleanyesWhether the component painted the intended result before it was acknowledged. True means the UI is currently showing something no layer has confirmed, and that must be reconcilable from the resolved state alone.
/retryOfEffectIdstringnoThe effectId this request replays. Present only when the prior recovery kind was 'retry' AND retrySafe was true.
/subjectKeystringnomin length 1Stable address of the subject this mutation is about - this reward, not the one beside it - holding across every attempt to write it. A layer reconstructing interaction state from the event stream alone has no store to consult and no context to close over, so subject identity has to arrive with the event or not exist. Absent means every attempt is its own region, which reports one subject written twice as two degraded things.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000003",
  "type": "com.augeo.ui.effect.requested",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "effectKind": "cart_add",
      "optimistic": false,
      "boundMs": 8000,
      "idempotencyKey": "idem_cart_prd_60417_den_25_gk_2e64aa"
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.effect.settled

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.effect.settled. The record that a requested mutation reached a terminal phase, emitted by the layer that resolved it. It reports what the component was HANDED, so that the rendered outcome and the committed outcome can be compared rather than assumed equal.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/durationMsintegernomin 0Milliseconds from request to settlement.
/effectKindstringyesmin length 1The component-local mutation name, echoing the ui.effect.requested that opened this effect.
/failureobjectnoPresent when phase is 'rejected'. Mirrors AugeoInteractionState.failure.
/failure/classenumyes"offline", "unreachable", "timeout", "rate-limited", "unauthorized", "content-filtered", "cancelled", "server", "unknown"How a slot or an effect failed. Nine classes. The class drives the recovery kind, and the recovery kind drives whether any affordance renders at all.
/failure/detailstringyesDiagnostic detail for logs and debugging. Not member-facing.
/failure/messagestringyesMember-facing copy. Subject to the BR-7 allowlist: never carries identity.
/optimisticReconciledbooleannoFor an optimistic request, whether the painted result matched the settled one. False is the signal that a member was shown something that did not happen.
/phaseenumyes"confirmed", "rejected", "unacknowledged"The terminal EffectPhase the component was handed.
/recoveryobjectnoWhat the member was offered next. A replay renders ONLY when kind is 'retry' AND retrySafe is true; any other kind may render its own action, never on the retry handler. Optional attempt and exits travel with it.
/recovery/attemptintegernomin 1Which try this recovery describes, counting from one. Written by the fold owner; a component must not mint it.
/recovery/exitsarraynoWays out that are not a replay. Only report and leave. The design system renders an exit only when this list names it.
/recovery/exits/0enumyes"report", "leave"
/recovery/kindenumyes"retry", "auto-retry-on-reconnect", "verify", "reauthenticate", "rephrase", "wait", "none"What the member can actually do next. Seven kinds. A replay renders ONLY when kind is 'retry' AND recovery.retrySafe is true; every other kind may still render its own affordance, on a separate handler, never the retry handler. An 'unacknowledged' effect NEVER offers 'retry' because the mutation may have committed - its recovery is 'verify'.
/recovery/retrySafebooleanyesWhether replaying the mutation is safe. Must be false whenever the phase is 'unacknowledged'.
/subjectKeystringnomin length 1The same stable subject address the matching ui.effect.requested carried, echoed so the settlement can be folded onto the right region without consulting a store. Envelope subject is a placement, correlation.effectId is one attempt, subjectKey is the thing being written to.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000004",
  "type": "com.augeo.ui.effect.settled",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "effectKind": "cart_add",
      "phase": "rejected",
      "durationMs": 610,
      "failure": {
        "class": "unauthorized",
        "detail": "SF_CAPABILITY_TOKEN_REJECTED",
        "message": "Your session expired. Sign in again to add this to your cart."
      },
      "recovery": {
        "kind": "reauthenticate",
        "retrySafe": false
      }
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.media.failed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.media.failed. An image, video or font a component depended on did not load. A quality signal, not a business measurement: a card that rendered with a broken image was still rendered, and without this name that difference is invisible in every impression count.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/fallbackAppliedbooleanyesWhether the component painted a fallback. False means the member saw a hole.
/mediaKindenumyes"image", "video", "audio", "font", "icon"What kind of asset failed.
/reasonenumyes"network", "decode", "not-found", "timeout", "blocked", "unsupported", "unknown"Why it failed, as far as the browser told the component.
/roleenumno"primary", "thumbnail", "decorative", "background", "logo"What the asset was doing in the component. A failed hero image and a failed decorative icon are not the same defect.
/srcstringnoThe asset reference that failed. Asset URLs only - subject to the BR-7 allowlist, so never a signed URL carrying identity.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000005",
  "type": "com.augeo.ui.media.failed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "mediaKind": "image",
      "reason": "network",
      "fallbackApplied": true
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.slot.declared

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.slot.declared. A region of content was declared BEFORE its content arrived. That ordering is the entire mechanism: content that was never promised cannot be reported as missing, so every later slot.filled, slot.settled, slot.failed and slot.dropped is only meaningful because this event went first. The occurrence IS the slot declaration.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/boundMsintegeryesmin 0The deadline, in milliseconds from declaration, after which a still-declared slot terminates. A bound that never expires is not a bound.
/expectobjectyesWhat the declaring layer expects to arrive. Declared up front so the shortfall is measurable rather than invisible.
/expect/countintegernomin 0How many units of that kind are expected. Absent means the count is unknown at declaration time.
/expect/kindstringyesmin length 1The expected content kind, for example 'cards', 'chart', 'table', 'text'.
/intentenumyes"requested", "decorative"'requested' means the member asked for this content and its absence is a failure. 'decorative' means the region enriches the answer and its absence is a drop, not a failure.
/labelstringyesHuman-readable name of the region, for example 'reward cards'. Used by accessibility announcements and by placement reporting.
/slotIdstringyesmin length 1Stable address of the region, for example 'slot.reward_cards'.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000006",
  "type": "com.augeo.ui.slot.declared",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "slotId": "slot.promo_banner",
      "label": "promo banner",
      "intent": "decorative",
      "expect": {
        "kind": "banner",
        "count": 1
      },
      "boundMs": 6000
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.slot.dropped

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.slot.dropped. A slot declared with intent 'decorative' was still unfilled when the stream closed or its boundMs elapsed. Enrichment that never arrived is a drop, not a failure - reporting it as a failure would bury the requested-content failures that actually hurt members, and is why intent is declared up front rather than inferred afterwards.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/boundMsintegernomin 0The declared deadline, echoed so the drop is auditable without rejoining the declaration.
/intentconstno"decorative"Always 'decorative'. A requested slot in the same situation emits ui.slot.failed instead.
/slotIdstringyesmin length 1The declared region that was dropped.
/terminatedByenumyes"bound-expired", "stream-closed", "superseded"Which of the two termination conditions fired, or whether the region was superseded before either.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-00000000000a",
  "type": "com.augeo.ui.slot.dropped",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "slotId": "slot.promo_banner",
      "intent": "decorative",
      "terminatedBy": "bound-expired",
      "boundMs": 6000
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.slot.failed

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.slot.failed. A slot declared with intent 'requested' was still unfilled when the stream closed or its boundMs elapsed. The member asked for this content and did not get it, so it terminates as a failure and not a drop. Without the prior declaration this event could not exist at all, which is the point of declaring first.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/boundMsintegernomin 0The declared deadline, echoed so the failure is auditable without rejoining the declaration.
/failureobjectyesWhy it failed. Mirrors AugeoInteractionState.failure.
/failure/classenumyes"offline", "unreachable", "timeout", "rate-limited", "unauthorized", "content-filtered", "cancelled", "server", "unknown"How a slot or an effect failed. Nine classes. The class drives the recovery kind, and the recovery kind drives whether any affordance renders at all.
/failure/detailstringyesDiagnostic detail for logs and debugging. Not member-facing.
/failure/messagestringyesMember-facing copy. Subject to the BR-7 allowlist: never carries identity.
/intentconstno"requested"Always 'requested'. A decorative slot in the same situation emits ui.slot.dropped instead.
/recoveryobjectnoWhat the member was offered next. A replay renders ONLY when kind is 'retry' AND retrySafe is true; any other kind may render its own action, never on the retry handler. Optional attempt and exits travel with it.
/recovery/attemptintegernomin 1Which try this recovery describes, counting from one. Written by the fold owner; a component must not mint it.
/recovery/exitsarraynoWays out that are not a replay. Only report and leave. The design system renders an exit only when this list names it.
/recovery/exits/0enumyes"report", "leave"
/recovery/kindenumyes"retry", "auto-retry-on-reconnect", "verify", "reauthenticate", "rephrase", "wait", "none"What the member can actually do next. Seven kinds. A replay renders ONLY when kind is 'retry' AND recovery.retrySafe is true; every other kind may still render its own affordance, on a separate handler, never the retry handler. An 'unacknowledged' effect NEVER offers 'retry' because the mutation may have committed - its recovery is 'verify'.
/recovery/retrySafebooleanyesWhether replaying the mutation is safe. Must be false whenever the phase is 'unacknowledged'.
/slotIdstringyesmin length 1The declared region that failed.
/terminatedByenumyes"bound-expired", "stream-closed"Which of the two termination conditions fired.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000009",
  "type": "com.augeo.ui.slot.failed",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "slotId": "slot.promo_banner",
      "intent": "requested",
      "terminatedBy": "bound-expired",
      "boundMs": 6000,
      "failure": {
        "class": "timeout",
        "detail": "bound-expired",
        "message": "We could not load this section."
      },
      "recovery": {
        "kind": "retry",
        "retrySafe": true
      }
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.slot.filled

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.slot.filled. Content arrived in a declared region. Compared against the declaration's expect block, this is what makes fill rate measurable per placement rather than inferred from the absence of complaints.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/filledobjectyesWhat actually arrived. Deliberately the same shape as the declaration's expect block so the shortfall is a subtraction, not a judgement call.
/filled/countintegernomin 0How many units arrived. A count below the declared expect.count is a partial fill, not a success.
/filled/kindstringyesmin length 1The content kind that arrived, for example 'cards'.
/latencyMsintegernomin 0Milliseconds from declaration to fill, measured against the same clock as the declaration's boundMs.
/partialbooleannoWhether the fill fell short of the declared expectation.
/slotIdstringyesmin length 1The declared region that received content.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000007",
  "type": "com.augeo.ui.slot.filled",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "slotId": "slot.reward_cards",
      "filled": {
        "kind": "cards",
        "count": 2
      },
      "latencyMs": 2414,
      "partial": false
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

com.augeo.ui.slot.settled

FieldValue
Classobserved
Type version1
Partnerno

data.occurrence for com.augeo.ui.slot.settled. A declared region that RECEIVED CONTENT reached a terminal SlotPhase. Emitted when the region resolved on its own terms - content arrived, or the source legitimately had nothing to show.

Fields

Paths are JSON pointers into the occurrence.

PathTypeMustRulesNote
/failureobjectnoPresent when phase is 'failure'. Mirrors AugeoInteractionState.failure.
/failure/classenumyes"offline", "unreachable", "timeout", "rate-limited", "unauthorized", "content-filtered", "cancelled", "server", "unknown"How a slot or an effect failed. Nine classes. The class drives the recovery kind, and the recovery kind drives whether any affordance renders at all.
/failure/detailstringyesDiagnostic detail for logs and debugging. Not member-facing.
/failure/messagestringyesMember-facing copy. Subject to the BR-7 allowlist: never carries identity.
/latencyMsintegernomin 0Milliseconds from declaration to settlement.
/phaseenumyes"success", "empty", "failure", "fallback", "cancelled"The terminal SlotPhase the region reached. 'timeout' is deliberately absent: a bound expiry terminates as ui.slot.failed or ui.slot.dropped, never as a settlement, so that exactly one terminal event exists per slot.
/recoveryobjectnoWhat the member was offered next. A replay renders ONLY when kind is 'retry' AND retrySafe is true; any other kind may render its own action, never on the retry handler. Optional attempt and exits travel with it.
/recovery/attemptintegernomin 1Which try this recovery describes, counting from one. Written by the fold owner; a component must not mint it.
/recovery/exitsarraynoWays out that are not a replay. Only report and leave. The design system renders an exit only when this list names it.
/recovery/exits/0enumyes"report", "leave"
/recovery/kindenumyes"retry", "auto-retry-on-reconnect", "verify", "reauthenticate", "rephrase", "wait", "none"What the member can actually do next. Seven kinds. A replay renders ONLY when kind is 'retry' AND recovery.retrySafe is true; every other kind may still render its own affordance, on a separate handler, never the retry handler. An 'unacknowledged' effect NEVER offers 'retry' because the mutation may have committed - its recovery is 'verify'.
/recovery/retrySafebooleanyesWhether replaying the mutation is safe. Must be false whenever the phase is 'unacknowledged'.
/slotIdstringyesmin length 1The declared region that settled.

Sample

Not in the partner profile.

{
  "spec": "augeo.event",
  "specversion": "1.0",
  "id": "00000000-0000-4000-8000-000000000008",
  "type": "com.augeo.ui.slot.settled",
  "typeversion": 1,
  "time": 1794927840000,
  "class": "observed",
  "source": {
    "surface": "partner_api",
    "instanceId": "encore-values"
  },
  "correlation": {},
  "data": {
    "occurrence": {
      "slotId": "slot.reward_cards",
      "phase": "success",
      "latencyMs": 2466
    },
    "context": {
      "host": {
        "applicationName": "rewardshub"
      }
    }
  }
}

On this page

Event listIndexcom.augeo.conversation.connectivity.lostFieldsSamplecom.augeo.conversation.connectivity.restoredFieldsSamplecom.augeo.conversation.decline.shownFieldsSamplecom.augeo.conversation.error.shownFieldsSamplecom.augeo.conversation.feedback.givenFieldsSamplecom.augeo.conversation.handoff.acceptedFieldsSamplecom.augeo.conversation.handoff.offeredFieldsSamplecom.augeo.conversation.launcher.activatedFieldsSamplecom.augeo.conversation.launcher.viewedFieldsSamplecom.augeo.conversation.message.receivedFieldsSamplecom.augeo.conversation.message.sentFieldsSamplecom.augeo.conversation.prompt.selectedFieldsSamplecom.augeo.conversation.sdk.loadedFieldsSamplecom.augeo.conversation.session.endedFieldsSamplecom.augeo.conversation.session.startedFieldsSamplecom.augeo.conversation.shell.closedFieldsSamplecom.augeo.conversation.shell.fallbackFieldsSamplecom.augeo.conversation.shell.openedFieldsSamplecom.augeo.conversation.tool.invokedFieldsSamplecom.augeo.conversation.tool.settledFieldsSamplecom.augeo.conversation.turn.admission_reportedFieldsstatus is "admitted"status is "rejected"status is "failed"status is "uncertain"Samplecom.augeo.conversation.turn.first_tokenFieldsSamplecom.augeo.conversation.turn.requestedFieldsSamplecom.augeo.conversation.turn.settledFieldsSamplecom.augeo.conversation.turn.stalledFieldsSamplecom.augeo.conversation.turn.startedFieldsSamplecom.augeo.conversation.turn.wait_crossedFieldsSamplecom.augeo.engagement.cart.item.addedFieldsSamplecom.augeo.engagement.cart.item.removedFieldsSamplecom.augeo.engagement.cart.item.updatedFieldsSamplecom.augeo.engagement.component.loadedFieldsSamplecom.augeo.engagement.item.activatedFieldsSamplecom.augeo.engagement.item.detail.viewedFieldsSamplecom.augeo.engagement.item.savedFieldsSamplecom.augeo.engagement.item.unsavedFieldsSamplecom.augeo.engagement.item.viewedFieldsSamplecom.augeo.engagement.redemption.completedFieldsSamplecom.augeo.engagement.redemption.startedFieldsSamplecom.augeo.engagement.search.performedFieldsoutcome is "success"outcome is "empty", resultCount is 0Samplecom.augeo.engagement.search.submittedFieldsSamplecom.augeo.factory.implementation.completedFieldsSamplecom.augeo.factory.implementation.errorFieldsSamplecom.augeo.factory.implementation.startedFieldsSamplecom.augeo.factory.implementation.turnFieldsSamplecom.augeo.preference.declaredFieldsSamplecom.augeo.preference.quiz.shownFieldsSamplecom.augeo.preference.quiz.startedFieldsSamplecom.augeo.preference.quiz.step.completedFieldsSamplecom.augeo.preference.quiz.step.viewedFieldsSamplecom.augeo.profile.media.addedFieldsSamplecom.augeo.profile.prompt.answeredFieldsSamplecom.augeo.profile.reaction.changedFieldsSamplecom.augeo.profile.updatedFieldsVariant 1field is "chips"Samplecom.augeo.profile.viewedFieldsSamplecom.augeo.recognition.givenFieldsSamplecom.augeo.recognition.initiatedFieldsSamplecom.augeo.recognition.receivedFieldsSamplecom.augeo.ui.action.pressedFieldsSamplecom.augeo.ui.component.renderedFieldsSamplecom.augeo.ui.component.viewedFieldsSamplecom.augeo.ui.effect.requestedFieldsSamplecom.augeo.ui.effect.settledFieldsSamplecom.augeo.ui.media.failedFieldsSamplecom.augeo.ui.slot.declaredFieldsSamplecom.augeo.ui.slot.droppedFieldsSamplecom.augeo.ui.slot.failedFieldsSamplecom.augeo.ui.slot.filledFieldsSamplecom.augeo.ui.slot.settledFieldsSample