User Report (Deprecated)
Deprecated user feedback mechanism — use the Feedback spec instead.
This document uses key words such as "MUST", "SHOULD", and "MAY" as defined in RFC 2119 to indicate requirement levels.
Statusdeprecated
User reports are a deprecated way of submitting user feedback. They associate user information and comments with an existing error event. New implementations MUST use the feedback item type instead.
User reports continue to work so older SDKs won't break. If both the item and its associated event are accepted, the backend converts the report into a feedback event.
Deprecatedspecified since 1.0.0
Item type "user_report". The item contains a JSON payload:
Copied
{ "event_id": "9ec79c33ec9942ab8353589fcb2e04dc", "email": "john@example.com", "name": "John Me", "comments": "It broke." } | Field | Type | Required | Since | Description |
|---|---|---|---|---|
event_id | String | REQUIRED | 1.1.0 | The identifier of the associated event, ideally an error. (since 1.2.0) Updated from "identifier of the event or transaction" to clarify this refers to an associated error event. |
email | String | RECOMMENDED | 1.1.0 | The email of the user. |
name | String | RECOMMENDED | 1.1.0 | The name of the user. |
comments | String | RECOMMENDED | 1.1.0 | Comments of the user about what happened. (since 1.2.0) Max length: 4096 characters. |
- This Item MAY occur once per Envelope.
- User Reports can be ingested separately from their events. However, SDKs SHOULD send them in the same Envelope.
- (since 1.2.0) SDKs MUST NOT associate multiple User Reports to the same event.
- (since 1.2.0) The event can not be more than 30 minutes old.
- (since 1.2.0) If the event does not exist in the same project or was never ingested, the report is discarded and never converted to feedback.
event_id- UUID String, required. Corresponds to the
event_idfield of the payload. (since 1.2.0) If the identifier mismatches between the Envelope and payload, the Envelope header takes precedence.
None
Deprecatedspecified since 1.1.0
Copied
captureUserFeedback(userFeedback) -> void Parameters:
userFeedback— Object containingevent_id(required), and optionallyemail,name,comments.
(since 1.2.0) SDKs that still expose this function SHOULD mark it as deprecated and direct users to captureFeedback instead.
| Version | Date | Summary |
|---|---|---|
1.2.1 | 2025-01-21 | Typo fix in deprecation description |
1.2.0 | 2025-01-08 | Deprecated in favor of `feedback` item type — added max length (4096) for comments, added constraints (no multiple per event, 30-minute event age limit, discard on missing event), updated event_id semantics |
1.1.0 | 2020-10-30 | Added payload attributes (event_id, email, name, comments) and JSON example |
1.0.0 | 2020-05-05 | Initial spec — user_report envelope item type, basic constraints, envelope headers |
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").