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

    View detailed open rate of an announcement

    Retrieves detailed open rate information on an announcement.


    HTTP request

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

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    unique_id

    string

    Specifies the unique ID of an announcement.

    OptionalTypeDescription

    days

    int

    Specifies the number of days to retrieve detailed open rate information per hour. The specified period is calculated from the time the announcement was sent. The data is cumulated on an hourly basis, so each value separated by a comma in the response represents an hourly open count and open rate. (Default: 7)


    Response

    If successful, this action returns the open rate information of a specific announcement in the response body.

    {
        "unique_id": "marketing_announcement_20200211",
        "open_counts": [1, 2, 3, ... ],
        "open_rates": [0.0, 0.001, 0.02, ... ],
        "cumulative_open_counts": [1, 3, 6, ... ],
        "cumulative_open_rates": [0.0, 0.001, 0.021, ... ]
    }
    

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