Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Add client report item type to envelopes spec #535

Merged
merged 2 commits into from
Mar 30, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/docs/sdk/envelopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,26 @@ The item contains a user feedback / user report JSON payload:

*None*

### Client Report

Item type `"client_report"` contains a client report payload encoded in JSON.

See the <Link to="/sdk/client-reports/">client reports</Link> documentation for the payload
details.

**Constraints:**

- This Item may occur multiple times per Envelope, but please avoid sending more client reports than necessary.
- This Item can either be included in an Envelope with other Items, or it may be sent by itself.

**Envelope Headers:**

*None*

**Additional Item Headers:**

*None*

### Reserved Types

Reserved types may not be written by any implementation. They are reserved for
Expand Down