Register and schedule a data export

POST {{baseUrl}}/v3/export/:data_type

Register and schedule a data export

Registers and schedules a message, channel, or user data export.

https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-register-and-schedule-a-data-export

Request Body

{"start_ts"=>"<integer>", "end_ts"=>"<integer>", "format"=>"<string>", "csv_delimiter"=>"<string>", "timezone"=>"<string>", "sender_ids"=>["<string>", "<string>"], "exclude_sender_ids"=>["<string>", "<string>"], "channel_urls"=>["<string>", "<string>"], "exclude_channel_urls"=>["<string>", "<string>"], "user_ids"=>["<string>", "<string>"], "show_read_receipt"=>"<boolean>", "show_channel_metadata"=>"<boolean>", "neighboring_message_limit"=>"<integer>"}

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;channel_custom_types&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;data_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;format&quot;:&quot;\u003cstring\u003e&quot;,&quot;csv_delimiter&quot;:&quot;\u003cstring\u003e&quot;,&quot;timezone&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;start_ts&quot;:&quot;\u003cnumber\u003e&quot;,&quot;end_ts&quot;:&quot;\u003cnumber\u003e&quot;,&quot;channel_urls&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;sender_ids&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;file&quot;:{&quot;url&quot;:&quot;\u003cstring\u003e&quot;,&quot;expires_at&quot;:&quot;\u003cnumber\u003e&quot;},&quot;user_ids&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}