Error signals
There are two types of errors supported:
- Application errors are 400- and 500-series status codes, as well as "caught" exceptions that present application error messages to the data layer, the DOM, or the user interface.
- User errors are those that are primarily due to a user interacting with an application in an unexpected way - or in a way that does not pass validation. Even if the error maybe said to be caused by bad application design, the error would be classified as user error. Examples: "Please complete all required fields" or "Email format is incorrect".
Configuration
Required fields
Field | Values | Definition |
---|---|---|
category | String. Valid value - Behavior . | The category of the signal |
name | String, up to 256 characters | Assign a name to the signal to differentiate it from other signals. |
signalType | String. Valid value -error . | The type of signal to enable |
errorType | String. Valid values: - application - user | Either a user error like entering a letter in a quantity field or an application error like a 404 page not found. |
errorIdentifier | String | Identifier of the error. Example: Status 404. |
errorText | String | Content of the error message received. |
Optional fields
Field | Values | Definition |
---|---|---|
effect | String. Valid values: - negative - positive | Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring. By default, each signal is assigned negative or positive. |
pageCategory | String | Reflects the type of page e.g. home, listing, details, search, etc. |
signalCustomAttributes | String | Allows for custom attributes that are not predefined by the product |
Sample payload
{
"signalType": "error",
"category": "Behavior",
"name": "error from product page",
"errorType": "user",
"errorText": "Minimum purchase not completed",
"errorIdentifier": "Error 400 Bad request",
"effect": "negative"
}
Updated 12 days ago