Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Report

    List reports

    Retrieves a list of reports within an application.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/report
    

    Parameters

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    token

    string

    Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set to 0.

    limit

    int

    Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)

    start_ts

    long

    Specifies a timestamp in Unix milliseconds to only retrieve reports which have been submitted after the specified time.

    end_ts

    long

    Specifies a timestamp in Unix milliseconds to only retrieve reports which have been submitted before the specified time.

    ?token=Zh0RRlxVQ1RMFUFfWV1Xfg&limit=3&start_ts=1568785280
    

    Response

    If successful, this action returns a list of report resources in the response body.

    {
        "report_logs": [
            {
                "report_type": "user",
                "report_category": "harassing",
                "offending_user": {
                    "user_id": "Drake",
                    "nickname": "TooLate",
                    "profile_url": "https://sendbird.com/main/img/profiles/profile_432_512px.png",
                    "metadata": {
                        "location": "Toronto",
                        "marriage": "N"
                    }
                },
                "reported_message": null,
                "channel": {
                    "name": "PBR&B songs",
                    "channel_url": "sendbird_group_channel_15458190_3ce474cfbb465c513de1728c7283bec63f00deea",
                    "cover_url": "",
                    "custom_type": "",
                    "unread_message_count": 0,
                    "unread_mention_count": 0,
                    "data": "",
                    "is_distinct": true,
                    "is_public": false,
                    "is_super": false,
                    "is_ephemeral": false,
                    "is_discoverable": false,
                    "is_access_code_required": false,
                    "member_count": 3,
                    "joined_member_count": 3,
                    "members": [
                        ... # A list of channel members.
                    ],
                    "max_length_message": -1,
                    "last_message": {
                        ... # The information of the channel's last message.
                    },
                    "created_at": 1568775527,
                    "freeze": false
                },
                "report_description": "using dirty words too much",
                "created_at": 1568816730
            },
            ... # More reports within an application.
        ],
        "next": "LMZ2aVnQdE4EU3XWFNeF25dFkF~Ad~"
    }
    

    List of response properties

    Property nameTypeDescription

    report_logs

    nested object

    A list of reports within an application.

    next

    string

    The value for the token parameter to retrieve the next page in the result set.

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