/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Data export

    Get a data export

    Copy link

    Retrieves information on a message, channel, or user data export.

    HTTP request

    Copy link
    GET https://api-{application_id}.sendbird.com/v3/export/{data_type}/{request_id}

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    data_type

    string

    Specifies the type of a data export. Acceptable values are messages, channels, users, and failed_webhooks.

    request_id

    string

    Specifies the unique ID of a data export.

    Response

    Copy link

    If successful, this action returns a data export resource and export status in the response body. When the value of status is done, the URL link to the data export results is included in the response.

    messageschannelsusersfailed_webhooks
    {
    "request_id": "afb8aeefc334465",
    "data_type": "messages",
    "status": "done",
    "format": "csv",
    "created_at": 1578897175000,
    "end_ts": 1578927599000,
    "start_ts": 1577718000000,
    "channel_custom_types": [],
    "sender_ids": [
        "Tom", "Jeff", "Rommel"
    ],
    "channel_urls": ["public_chat_room_031", "public_chat_room_032"]
    "csv_delimiter": ",",
    "file": {
        "url": "https://sendbird-us-1.s3.amazonaws.com/rfd34edfc3d4422.zip?AWSAccessKeyId=AKDKEKFCSDSMJDK2PZCA&Expires=1579502105&Signature=RZ%2FcTbRMpDtOEwxmDFjIJV%2Fuolg%e1",
        "expires_at": 1579502105432
    },
    "timezone": "US/Pacific"
}

    In the case of an error, an error object is returned. A detailed list of error codes is available here.

    On this page
    HTTP requestParametersResponse