/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    Get detailed open rate of an announcement

    Copy link

    Retrieves detailed open rate information on an announcement.

    HTTP request

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

    Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with https://api-{application_id}.svc.delight.ai/v3 instead of https://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    unique_id

    string

    Specifies the unique ID of an announcement.

    OptionalTypeDescription

    days

    integer

    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

    Copy link

    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.

    On this page
    HTTP requestParametersResponse