Get campaigns list

GET

/campaigns

Get a list of campaigns for a specific period

Request

Query Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/campaigns?dateFrom=2018-05-30&dateTo=2018-05-31&limit=100&offset=102&q=Alpha&medium=sms&type=automated&from=info%40mail.incomaker.com&sort=-campaignId%2Cname' \
--header 'Authorization: Bearer JWT'

Response Example

200 - Success

{
    "campaigns": [
        {
            "campaignId": "11ef6061-cef7-b850-ada7-c969374ebcce",
            "name": "Get an extra 10% off on top of our 30% summer sale!",
            "from": "info@news.incomaker.cz",
            "datetime": "2018-05-30T13:00:00+00:00",
            "medium": "e-mail",
            "type": "regular",
            "sent": 1282,
            "delivered": 1280,
            "opened": 232,
            "clicked": 24,
            "unsubscribed": 2,
            "spam": 0,
            "openRate": 0.181,
            "clickThroughRate": 0.018,
            "clickToOpenRate": 0.103,
            "conversionsAmount": 1287,
            "conversionsNumber": 1,
            "conversionsCurrency": "EUR"
        },
        {
            "campaignId": "aanf6061-ce17-2222-ada7-c969374ebbaf",
            "name": "Last chance!",
            "from": "info@news.incomaker.cz",
            "datetime": "2018-06-30T10:00:00+00:00",
            "medium": "SMS",
            "type": "regular",
            "sent": 527,
            "delivered": 527,
            "opened": 280,
            "clicked": 250,
            "unsubscribed": 2,
            "openRate": 0.531,
            "clickThroughRate": 0.474,
            "clickToOpenRate": 0.892,
            "conversionsAmount": 5824,
            "conversionsNumber": 2,
            "conversionsCurrency": "EUR"
        },
        {
            "campaignId": "banf6061-ce17-2222-ada7-c969374ebba1",
            "name": "Last chance!",
            "from": "info@news.incomaker.cz",
            "datetime": "2018-06-30T10:00:00+00:00",
            "medium": "SMS",
            "type": "regular",
            "sent": 527,
            "delivered": 527,
            "opened": 280,
            "clicked": 250,
            "unsubscribed": 2,
            "openRate": 0.531,
            "clickThroughRate": 0.474,
            "clickToOpenRate": 0.892,
            "conversionsAmount": 5824,
            "conversionsNumber": 2,
            "conversionsCurrency": "EUR"
        },
        {
            "campaignId": "banf6061-ce17-2222-ada7-c969374ebba1",
            "name": "Last chance!",
            "from": "info@news.incomaker.cz",
            "datetime": "2018-06-30T10:00:00+00:00",
            "medium": "SMS",
            "type": "regular",
            "sent": 527,
            "delivered": 527,
            "opened": 280,
            "clicked": 250,
            "unsubscribed": 2,
            "openRate": 0.531,
            "clickThroughRate": 0.474,
            "clickToOpenRate": 0.892,
            "conversionsAmount": 5824,
            "conversionsNumber": 2,
            "conversionsCurrency": "EUR"
        },
        {
            "campaignId": "banf6061-ce17-2222-ada7-c969374ebba1",
            "name": "Last chance!",
            "from": "info@news.incomaker.cz",
            "datetime": "2018-06-30T10:00:00+00:00",
            "medium": "SMS",
            "type": "regular",
            "sent": 527,
            "delivered": 527,
            "opened": 280,
            "clicked": 250,
            "unsubscribed": 2,
            "openRate": 0.531,
            "clickThroughRate": 0.474,
            "clickToOpenRate": 0.892,
            "conversionsAmount": 5824,
            "conversionsNumber": 2,
            "conversionsCurrency": "EUR"
        }
    ],
    "paging": {
        "start": 1,
        "count": 5,
        "totalCount": 12
    }
}

Modified at 2026-06-08 15:36:31

Get campaigns count and metrics by language

Get campaigns daily results