Raporty – Web push – raport pojedynczej wiadomości

Ta metoda zwraca statystyki skuteczności dla jednej wiadomości Web Push w ECDP. Pokazuje najważniejsze wskaźniki związane z dostarczaniem i reakcją odbiorców, takie jak liczba wysłanych wiadomości, odrzuceń, wyświetleń, kliknięć oraz wygenerowany przychód.

Możesz też pobrać podstawowe informacje o wiadomości, na przykład jej nazwę, parametry UTM oraz stronę internetową, z którą jest powiązana. Dzięki tym danym łatwiej ocenisz, jak poradziła sobie konkretna wiadomość Web Push i co warto poprawić w kolejnych wysyłkach.

Endpoint

GET /reports/webpush/singleMessage/{id}

Host: https://api.ecdp.app

Parametry zapytania

Filtry

Użyj parametru website, aby zawęzić wyniki do konkretnej strony internetowej. W jednym żądaniu obsługiwany jest tylko jeden filtr.

Opcje grupowania

W jednym żądaniu dozwolona jest dokładnie jedna wartość grupowania. Jeśli zostanie pominięta, stosowane jest grupowanie domyślne.

Domyślne: grouping=Message

Odpowiedź

Web push report data

Każdy obiekt w tablicy reprezentuje jeden wiersz zagregowanych statystyk, pogrupowanych zgodnie z parametrem grouping.

Message details

Sekcja obecna tylko gdy includeDetails=true.

Przykładowe zapytania i odpowiedzi

Newsletter ze szczegółami i grupowaniem po ‘Message’

GET /reports/webpush/singleMessage/9921?includeDetails=true

Odpowiedź (200 OK):

{
  "messageDetails": {
    "messageId": "9921",
    "type": "Newsletter",
    "name": "Spring Deals WebPush",
    "utms": [
      { "name": "utm_source", "value": "webpush" },
      { "name": "utm_campaign", "value": "spring_deals" }
    ],
    "sentDate": "2025-03-10T08:00:00Z",
    "websiteId": 1,
    "websiteName": "shop.example.com"
  },
  "data": [
    {
      "messageId": "9921",
      "messageName": "Spring Deals WebPush",
      "sent": 150000,
      "bounce": 1200,
      "bouncePercent": 0.008,
      "view": 72000,
      "viewPercent": 0.48,
      "click": 9500,
      "clickPercent": 0.0633,
      "clicksToViewsPercent": 0.1319,
      "revenue": 8421.55,
      "currency": "PLN"
    }
  ]
}

{
  "messageDetails": {
    "messageId": "9921",
    "type": "Newsletter",
    "name": "Spring Deals WebPush",
    "utms": [
      { "name": "utm_source", "value": "webpush" },
      { "name": "utm_campaign", "value": "spring_deals" }
    ],
    "sentDate": "2025-03-10T08:00:00Z",
    "websiteId": 1,
    "websiteName": "shop.example.com"
  },
  "data": [
    {
      "messageId": "9921",
      "messageName": "Spring Deals WebPush",
      "sent": 150000,
      "bounce": 1200,
      "bouncePercent": 0.008,
      "view": 72000,
      "viewPercent": 0.48,
      "click": 9500,
      "clickPercent": 0.0633,
      "clicksToViewsPercent": 0.1319,
      "revenue": 8421.55,
      "currency": "PLN"
    }
  ]
}

Powiadomienie użyte w scenariuszu z zakresem dat, filtrem strony i grupowaniem po ‘Website’

GET /reports/webpush/singleMessage/457?startDate=2025-03-01&endDate=2025-03-07&website=1&grouping=Website

Odpowiedź (200 OK):

{
  "data": [
    {
      "websiteId": 1,
      "websiteName": "shop.example.com",
      "sent": 28000,
      "bounce": 310,
      "bouncePercent": 0.0111,
      "view": 14050,
      "viewPercent": 0.5018,
      "click": 2100,
      "clickPercent": 0.075,
      "clicksToViewsPercent": 0.1494,
      "revenue": 2310.00,
      "currency": "PLN"
    }
  ]
}

{
  "data": [
    {
      "websiteId": 1,
      "websiteName": "shop.example.com",
      "sent": 28000,
      "bounce": 310,
      "bouncePercent": 0.0111,
      "view": 14050,
      "viewPercent": 0.5018,
      "click": 2100,
      "clickPercent": 0.075,
      "clicksToViewsPercent": 0.1494,
      "revenue": 2310.00,
      "currency": "PLN"
    }
  ]
}

Kody odpowiedzi

Reguły walidacji i zachowania

• W jednym żądaniu dozwolona jest tylko jedna wartość grupowania. Podanie wielu wartości grupowania zwraca 400 Bad Request.
• W jednym żądaniu dozwolony jest tylko jeden typ filtru. Każdy filtr przyjmuje dokładnie jedną wartość. Podanie wielu filtrów lub wielu wartości zwraca 400 Bad Request.
• Dla wiadomości Scenariusz oba parametry startDate i endDate są wymagane. Jeśli któryś z nich brakuje, żądanie zwraca 400 Bad Request.

Dokumentacja referencyjna

Swagger — Reports web push

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