GEgetstream
product:chat

Export channels

Changed on

Exports channel data to a JSON or CSV file (CSV requires version=v2)

post/export_channels

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/export_channels
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

clear_deleted_message_textboolean

Set if deleted message text should be cleared

export_usersboolean
format'json' | 'csv'

Output format: 'json' (default) or 'csv'. csv requires version=v2 and is incompatible with export_users

include_fieldsstring[]

For csv format: subset of message columns to include (defaults to a standard set)

include_soft_deleted_channelsboolean

Set if you want to include deleted channels

include_truncated_messagesboolean

Set if you want to include truncated messages

versionstring

Export version

Response

Successful response

durationstring required

Duration of the request in milliseconds

task_idstring required

ID of the task to export channels

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • fb5873382d39Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property