This article lists the events generated by the Customer Agent. To learn what the events tell you and how to analyze them, see Measuring the Customer Agent.
assistant.click
An event generated when an item shown in the agent response is clicked.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| assistantId | string | d9710386-8de5-4d71-8327-93c0411b4b3c |
The ID of the agent configuration |
| channel | string | web |
The channel within which the conversation has started; possible values: WEB_DESKTOP, MOBILEWEB, MOBILE_APP |
| clickedFromComponent | string | CAROUSEL |
Message-element type the clicked item was rendered in (for example, CAROUSEL, BUBBLE_TEXT). |
| correlationId | string | 43cc2e3f-df11-4c78-abe1-4d0710abba3f |
Correlation ID is used to associate events that are the result of the same request, for example to link a recommendation frame with a recommendation.click event, a search request with an item.search.click event, or a user's conversational turn with the corresponding assistant.click event. |
| itemId | string | 123456 |
The ID of the clicked item |
| seqNo | integer | 4 |
Sequential number of this response within the thread, starting from 0 |
| threadId | string | 93d3cc74-a909-4cd9-b725-3e349d949c8b |
The ID of the conversation |
assistant.conversationStart
An event generated when a profile starts a conversation with the agent.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| assistantId | string | d9710386-8de5-4d71-8327-93c0411b4b3c |
The ID of the agent configuration |
| channel | string | web |
The channel within which the conversation has started; possible values: WEB_DESKTOP, MOBILEWEB, MOBILE_APP |
| threadId | string | 93d3cc74-a909-4cd9-b725-3e349d949c8b |
The ID of the conversation |
| eventWeight | float | 0.01727089956 |
Event weight, dynamic for each event, identifying the amount of work performed. Used for billing purposes. |
assistant.responseFeedback
An event generated when a customer rates the agent's response with thumbs up or thumbs down.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| assistantId | string | d9710386-8de5-4d71-8327-93c0411b4b3c |
The ID of the agent configuration |
| channel | string | web |
The channel within which the conversation has started; possible values: WEB_DESKTOP, MOBILEWEB, MOBILE_APP |
| comment | string | The shoes are too expensive |
The comment left by the customer. Customers can add a comment only after a thumbs down. |
| correlationId | string | 43cc2e3f-df11-4c78-abe1-4d0710abba3f |
Correlation ID is used to associate events that are the result of the same request, for example to link a recommendation frame with a recommendation.click event, a search request with an item.search.click event, or a user's conversational turn with the corresponding assistant.click event. |
| seqNo | integer | 4 |
Sequential number of this response within the thread, starting from 0 |
| threadId | string | 93d3cc74-a909-4cd9-b725-3e349d949c8b |
The ID of the conversation |
| vote | string | NEGATIVE |
The customer's rating of the response. Possible values: POSITIVE, NEGATIVE |
assistant.responseGenerated
An event generated when the agent produces a response to a profile's message.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| action | string | search | Type of action taken to produce the response. Covers every conversational turn outcome, including non-tool ones. Null when no action was resolved (for example, an error occurred before planning). Possible values: search, recommend, brickworks, answer_products, reject, clarify, button_action, mcp_tool, link, message |
| assistantId | string | d9710386-8de5-4d71-8327-93c0411b4b3c |
The ID of the agent configuration |
| channel | string | web |
The channel within which the conversation has started; possible values: WEB_DESKTOP, MOBILEWEB, MOBILE_APP |
| context | string | {"context_category": "electronics"} |
Arbitrary contextual key/value pairs captured for the turn |
| correlationId | string | 43cc2e3f-df11-4c78-abe1-4d0710abba3f |
Correlation ID is used to associate events that are the result of the same request, for example to link a recommendation frame with a recommendation.click event, a search request with an item.search.click event, or a user's conversational turn with the corresponding assistant.click event. |
| errorReason | string | AgentExecutionError |
Human-readable error reason; set only when status is ERROR |
| eventWeight | float | 0.01727089956 |
Event weight, dynamic for each event, identifying the amount of work performed. Used for billing purposes. |
| guardrails | object | {"blocked": false, "validators": []} |
Determines whether the agent response has been blocked by the Guardrails policy |
| items | array | ["12345","67891","23456","78901","23344"] |
A list of item IDs that has been returned in response |
| requestParams | object | {"fastMode": false,"streaming": true } |
Agent's settings (determines whether streaming and fastModes are enabled) |
| selectedModel | string | null |
For future use |
| seqNo | integer | 4 |
Sequential number of this response within the thread, starting from 0 |
| status | string | ok |
Outcome of producing the response, when the response is ERROR then the errorReason parameter is included in this event. |
| threadId | string | 93d3cc74-a909-4cd9-b725-3e349d949c8b |
The ID of the conversation |
| toolCallParams | object | {} |
Breakdown of parameters for each tool invoked during this turn, grouped by tool type |
| toolCallsCnt | object | {"SEARCH": 1} |
Number of invocations for each tool type used during this conversational turn. Tool types with no invocations are omitted. |