Exporting Data
Confused about "Exporting Data"?
Let us know how we can improve our documentation:
Exporting Channels
Copied!Confused about "Exporting Channels"?
Let us know how we can improve our documentation:
This method allows you to request an export of one or many channels and download all messages and metadata. Channel exports are created asynchronously, you can use the Task ID
returned by the APIs to keep track of the status and to download the final result when it is ready.
The data created by the export is following the same format as the regular APIs and is JSON encoded. By default the entire history is included in the export (excluding truncated messages), but you may optionally request the export to include only the messages in a specific interval using the messages_since
and messages_until
parameters. You can also include truncated messages, by using include_truncated_messages: true
.
Requesting a channel export
Copied!Confused about "Requesting a channel export"?
Let us know how we can improve our documentation:
you can use v2 version of the channel export by adding version:"v2"
in the request body which will use the new export for channels where each entity of the export would be exported as line separated json.
Retrieving the status of the export
Copied!Confused about "Retrieving the status of the export"?
Let us know how we can improve our documentation:
You can check the status of an export request using the task ID returned when the task was created. The result of the task contains the URL to the JSON file.
Timestamps will be returned in this format: "2021-02-17T08:17:49.745857Z" and are in UTC.
Exporting Users
Copied!Confused about "Exporting Users"?
Let us know how we can improve our documentation:
To export user data, Stream Chat exposes an exportUser
method. This method can only be called server-side due to security concerns, so please keep this in mind when attempting to make the call.
Below is an example of how to execute the call to export user data:
The export will return all data about the user, including:
User ID
Messages
Reactions
Custom Data