Get deliveries overview

Designing

GET

/deliveries/overview

Dashboard list: one row per thing you run rather than per send. Each smartflow collapses into a single top-level row summing all of its sending activities (same numbers GET /deliveries reports for that smartflow, including phantom-conversion filtering and trigger-node conversion rollup), and standalone campaigns sit alongside them in the same shape. Where /deliveries/sends would return five rows for a five-email smartflow, this returns one. Standalone campaigns with no email/SMS asset (medium=unknown, e.g. audience-sync campaigns pushing segments to ad platforms) are excluded by default; pass medium=unknown explicitly to include them. Default sort is -datetime.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location '/deliveries/overview?dateFrom=2026-01-01&dateTo=2026-03-31&limit=20&offset=0&q=Welcome&medium=e-mail&from=newsletter%40example.com&language=cs%2Csk&type=smartflow%2Ccampaign&sort=-datetime&order=-datetime' \
--header 'Authorization: Bearer JWT'

Response Example

200 - Example 1

{
    "items": [
        {
            "type": "string",
            "id": "string",
            "name": "string",
            "state": "string",
            "medium": "string",
            "from": "string",
            "language": "string",
            "datetime": "string",
            "sendCount": 0,
            "sent": 0,
            "delivered": 0,
            "opened": 0,
            "clicked": 0,
            "totalClicked": 0,
            "openRate": 0,
            "clickThroughRate": 0,
            "clickToOpenRate": 0,
            "unsubscribeRate": 0,
            "unsubscribed": 0,
            "spam": 0,
            "conversionsAmount": 0,
            "conversionsNumber": 0,
            "conversionsCurrency": "string"
        }
    ],
    "paging": {
        "start": 0,
        "count": 0,
        "totalCount": 0
    }
}

Modified at 2026-08-04 10:04:01

Get sends list

Get deliveries list