Raporty – E-mail – raport pojedynczej wiadomości

Ta metoda zwraca metryki dostarczalności i zaangażowania dla pojedynczej wysłanej wiadomości e-mail. Dzięki niej możesz sprawdzić najważniejsze wyniki, takie jak liczba dostarczonych wiadomości, otwarcia i kliknięcia, razem z ich wartościami procentowymi.

Statystyki są dostępne dla całej wiadomości, ale możesz też zobaczyć je w podziale na domenę odbiorcy, rodzinę domen lub adres IP, z którego została wysłana wiadomość. W razie potrzeby metoda zwraca również podstawowe informacje o wiadomości, takie jak temat, parametry UTM czy data wysyłki.

Endpoint

GET /reports/email/singleMessage/{id}

Host: https://api.ecdp.app

Parametry zapytania

Filtry

W jednym zapytaniu dozwolony jest tylko jeden typ filtra, a każdy filtr przyjmuje dokładnie jedną wartość. Podanie kilku filtrów lub kilku wartości zwraca błąd 400 Bad Request.

Opcje grupowania

W jednym zapytaniu dozwolona jest dokładnie jedna wartość grupowania. Grupowanie określa, która kolumna pojawi się w każdym wierszu tablicy data[].

Domyślnie: grouping=Message

Odpowiedź

Email report data

Każdy obiekt w tablicy data zawiera dokładnie jedną kolumnę grupowania (określoną przez parametr grouping), po której następują pola KPI opisane poniżej.

Message details

Obecne tylko gdy includeDetails=true.

Przykładowe zapytania i odpowiedzi

Newsletter z domyślnym grupowaniem i szczegółami wiadomości

GET /reports/email/singleMessage/12345?includeDetails=true

Odpowiedź: OK 200

{
  "messageDetails": {
    "messageId": "12345",
    "type": "Newsletter",
    "subject": "Wiosenna promocja",
    "utms": [
      { "name": "utm_source", "value": "newsletter" },
      { "name": "utm_campaign", "value": "marzec" }
    ],
    "sentDate": "2025-02-14T10:05:00Z"
  },
  "data": [
    {
      "messageId": "12345",
      "messageSubject": "Wiosenna promocja",
      "bounced": 20,
      "bouncedPercent": 0.002,
      "delivered": 9980,
      "deliveredPercent": 0.998,
      "opens": 5400,
      "opensPercent": 0.541,
      "uniqueOpens": 4200,
      "clicks": 1200,
      "clicksPercent": 0.120,
      "uniqueClicks": 950,
      "clicksToOpensPercent": 0.222,
      "unsubscribes": 10,
      "complaints": 3,
      "revenue": 3500.45,
      "currency": "PLN"
    }
  ]
}

{
  "messageDetails": {
    "messageId": "12345",
    "type": "Newsletter",
    "subject": "Wiosenna promocja",
    "utms": [
      { "name": "utm_source", "value": "newsletter" },
      { "name": "utm_campaign", "value": "marzec" }
    ],
    "sentDate": "2025-02-14T10:05:00Z"
  },
  "data": [
    {
      "messageId": "12345",
      "messageSubject": "Wiosenna promocja",
      "bounced": 20,
      "bouncedPercent": 0.002,
      "delivered": 9980,
      "deliveredPercent": 0.998,
      "opens": 5400,
      "opensPercent": 0.541,
      "uniqueOpens": 4200,
      "clicks": 1200,
      "clicksPercent": 0.120,
      "uniqueClicks": 950,
      "clicksToOpensPercent": 0.222,
      "unsubscribes": 10,
      "complaints": 3,
      "revenue": 3500.45,
      "currency": "PLN"
    }
  ]
}

Wiadomość e-mail użyta w scenariuszu, zgrupowana według domeny, z filtrem do gmail.com

GET /reports/email/singleMessage/123?startDate=2025-03-01&endDate=2025-03-07&grouping=Domain&domain=gmail.com

Odpowiedź: OK 200

{
  "data": [
    {
      "domain": "gmail.com",
      "bounced": 5,
      "bouncedPercent": 0.001,
      "delivered": 4995,
      "deliveredPercent": 0.999,
      "opens": 3200,
      "opensPercent": 0.640,
      "uniqueOpens": 2500,
      "clicks": 650,
      "clicksPercent": 0.130,
      "uniqueClicks": 500,
      "clicksToOpensPercent": 0.203,
      "unsubscribes": 4,
      "complaints": 1,
      "revenue": 1780.25,
      "currency": "PLN"
    }
  ]
}

{
  "data": [
    {
      "domain": "gmail.com",
      "bounced": 5,
      "bouncedPercent": 0.001,
      "delivered": 4995,
      "deliveredPercent": 0.999,
      "opens": 3200,
      "opensPercent": 0.640,
      "uniqueOpens": 2500,
      "clicks": 650,
      "clicksPercent": 0.130,
      "uniqueClicks": 500,
      "clicksToOpensPercent": 0.203,
      "unsubscribes": 4,
      "complaints": 1,
      "revenue": 1780.25,
      "currency": "PLN"
    }
  ]
}

Kody odpowiedzi#

Reguły walidacji i działania#

• Dla wiadomości Newsletter: parametry startDate i endDate są niedozwolone. Ich podanie zwraca błąd 400 Bad Request.
• Dla wiadomości Scenario i Confirmation: oba parametry startDate i endDate są wymagane. Pominięcie któregokolwiek z nich zwraca błąd 400 Bad Request.
• W jednym żądaniu dozwolona jest dokładnie jedna wartość grupowania. Podanie kilku wartości zwraca błąd 400 Bad Request.
• W jednym żądaniu dozwolony jest dokładnie jeden typ filtra z dokładnie jedną wartością. Podanie kilku filtrów lub kilku wartości zwraca błąd 400 Bad Request.

Dokumentacja referencyjna

Swagger — Reports email

https://api.ecdp.app/swagger/index.html