Marketing Campaigns

Our API provides a comprehensive set of metrics related to your Marketing campaigns. You can track the number of emails sent, opened, and clicked. It also presents data on unsubscribes, soft bounces and hard bounces.

Another crucial feature is that you can monitor the number and amount of reservations generated as a result of your campaigns.

Additionally, you can review the email subjects in different languages and the utilized Analytics tags. The API is organized according to the dates of your campaign dispatch, affording you the necessary flexibility when analyzing performance over different periods.

Request

GET

https://interface.experience-hotel.com/api/statistics/marketing-campaign/by-sending-date?date_from=2023-09-05&date_to=2023-09-10
Param
Format
Required
Description

date_start

YYYY-MM-DD

Required

date_end

YYYY-MM-DD

Required

hotel_id

Numeric

Optional

The unique identifier of a specific hotel for which you wish to retrieve campaign statistics. This parameter is optional. If your access token allows querying data for multiple hotels, you can use this parameter to limit the response to a specific hotel only. If this parameter is not used, the response will include the data for all accessible hotels.

Response

Status Code 200 OK

JSON
[
    {
        "date_sent": "2023-01-15T11:21:03.000000Z",
        "business_name": "Hotel test",
        "business_type": "hotel",
        "business_id": 12345,
        "configuration": {
            "name": "Campaign name",
            "subjects": [
                {
                    "code": "fr",
                    "text": "Subject in French"
                },
                {
                    "code": "en",
                    "text": "Subject in english"
                }
            ],
            "analytics_tags": {
                "source": null,
                "medium": null,
                "content": null,
                "term": null
            }
        },
        "performances": {
            "sent": 22825,
            "delivered": 21048,
            "opened": 9389,
            "clicked": 93,
            "unsubscribed": 128,
            "hard_bounced": 4,
            "soft_bounced": 35,
            "reservation_count": 65,
            "reservations": [
                {
                    "currency": "CZK",
                    "amount": 24110.7
                },
                {
                    "currency": "EUR",
                    "amount": 148169.1
                },
                {
                    "currency": "GBP",
                    "amount": 2755.7
                },
                {
                    "currency": "RSD",
                    "amount": 676707.8
                },
                {
                    "currency": "USD",
                    "amount": 1514.1
                }
            ]
        }
    }
]

Last updated