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
Key | Datatype | Required | Description |
---|---|---|---|
Api-Token | string | (Required) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"channel_custom_types":["\u003cstring\u003e","\u003cstring\u003e"],"data_type":"\u003cstring\u003e","request_id":"\u003cstring\u003e","status":"\u003cstring\u003e","format":"\u003cstring\u003e","csv_delimiter":"\u003cstring\u003e","timezone":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","start_ts":"\u003cnumber\u003e","end_ts":"\u003cnumber\u003e","channel_urls":["\u003cstring\u003e","\u003cstring\u003e"],"sender_ids":["\u003cstring\u003e","\u003cstring\u003e"],"file":{"url":"\u003cstring\u003e","expires_at":"\u003cnumber\u003e"},"user_ids":["\u003cstring\u003e","\u003cstring\u003e"]}