Raporty – Web push – raport zbiorczy - ExpertSender Centrum pomocy

Ta metoda zwraca podsumowanie skuteczności kanału Web Push dla wybranego zakresu dat. Pokazuje najważniejsze wskaźniki związane z dostarczaniem wiadomości, zaangażowaniem odbiorców i przychodami.

Dane mogą być pogrupowane na różne sposoby, np. według dnia, miesiąca, strony internetowej, wiadomości lub typu wiadomości. W ten sposób łatwo sprawdzisz, jak kanał web push radzi sobie w wybranym przedziale czasu, porównasz wyniki między różnymi stronami i zobaczysz, które typy wiadomości przynoszą najwięcej kliknięć i przychodów.

Endpoint

GET /reports/webpush/channel-summary

Host: https://api.ecdp.app

Parametry zapytania

Parametr	Lokalizacja	Typ	Wymagany	Opis	Dozwolone wartości / uwagi
x-api-key	header	string	tak	Klucz API do uwierzytelniania.	Dostępny w Ustawienia > API.
startDate	query	string	tak	Początek okresu raportowania (włącznie).	Format: YYYY-MM-DD.
endDate	query	string	tak	Koniec okresu raportowania (włącznie).	Format: YYYY-MM-DD.
grouping	query	string	nie	Poziom agregacji wyników.	Jedna z wartości: Date, Month, Website, Message, MessageType. Domyślnie: Date.
websiteId	query	integer lub string	nie	Zawęża wyniki do konkretnej strony internetowej.	ID strony (np. 123) lub nazwa (np. “MyWebsite”).
messageType	query	string	nie	Zawęża wyniki do jednego typu wiadomości.	Newsletter, Scenario.

Filtry

Filtry pozwalają zawęzić zestaw wyników do wybranego podzbioru danych.

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

Filtr	Typ	Opis
websiteId	integer lub string	Zwraca dane tylko dla wskazanej strony internetowej.
messageType	string	Zwraca dane tylko dla wskazanego typu wiadomości.

Opcje grupowania

W jednym żądaniu dozwolona jest dokładnie jedna wartość grupowania. Jeśli parametr zostanie pominięty, wyniki są grupowane według daty.

Domyślnie: grouping=Date

Wartość grupowania	Kolumna grupowania w odpowiedzi
Date	date (format: YYYY-MM-DD)
Month	month (format: YYYY-MM)
Website	websiteId, websiteName
Message	messageId, messageSubject
MessageType	messageType

Odpowiedź

Każdy wiersz tablicy odpowiedzi zawiera dokładnie jedną kolumnę grupowania (określoną przez parametr grouping) oraz następujące wskaźniki:

Pole	Typ	Opis
sent	integer	Łączna liczba wysłanych powiadomień Web Push.
bounced	integer	Liczba powiadomień, których nie udało się dostarczyć.
bouncedPercent	number	Niedostarczone jako procent wysłanych. Zwraca 0.0, jeśli sent = 0.
views	integer	Liczba powiadomień wyświetlonych odbiorcom (wyświetlenia).
viewsPercent	number	Wyświetlenia jako procent wysłanych. Zwraca 0.0, jeśli sent = 0.
clicks	integer	Liczba kliknięć w dostarczone powiadomienia.
clicksPercent	number	Kliknięcia jako procent wysłanych. Zwraca 0.0, jeśli sent = 0.
revenue	number	Łączny przychód przypisany do danej grupy.
currency	string	Kod waluty dla wartości przychodu (ISO 4217, np. EUR).

Przykładowe zapytania i odpowiedzi#

Raport z domyślnym grupowaniem według daty

GET /reports/webpush/channel-summary?startDate=2025-09-01&endDate=2025-09-07

Odpowiedź (200 OK):

{
  "data": [
    {
      "date": "2025-09-01",
      "sent": 52000,
      "bounced": 1500,
      "bouncedPercent": 2.88,
      "views": 43000,
      "viewsPercent": 82.69,
      "clicks": 6200,
      "clicksPercent": 11.92,
      "revenue": 18250.00,
      "currency": "PLN"
    },
    {
      "date": "2025-09-02",
      "sent": 48000,
      "bounced": 1200,
      "bouncedPercent": 2.50,
      "views": 40000,
      "viewsPercent": 83.33,
      "clicks": 5800,
      "clicksPercent": 12.08,
      "revenue": 16540.75,
      "currency": "PLN"
    }
  ]
}

Raport z grupowaniem według strony filtrem ‘message type’

GET /reports/webpush/channel-summary?startDate=2025-09-01&endDate=2025-09-30&grouping=Website&websiteId=101&messageType=Newsletter

Odpowiedź (200 OK):

{
  "data": [
    {
      "websiteId": 101,
      "websiteName": "My Website",
      "sent": 94000,
      "bounced": 2800,
      "bouncedPercent": 2.98,
      "views": 79800,
      "viewsPercent": 84.89,
      "clicks": 10900,
      "clicksPercent": 11.60,
      "revenue": 41250.50,
      "currency": "PLN"
    }
  ]
}

Kody odpowiedzi#

Kod	Status	Opis
200	OK	Żądanie przetworzone poprawnie. Odpowiedź zawiera dane podsumowania kanału.
204	Brak treści	Żądanie było prawidłowe, ale żadne dane nie pasują do podanych parametrów.
400	Błędne żądanie	Nieprawidłowe lub brakujące parametry, sprzeczne filtry albo nieprawidłowy zakres dat.
401	Brak autoryzacji	Klucz API jest nieprawidłowy, brakuje go lub wygasł. Sprawdź klucz w Ustawienia > API.
403	Brak dostępu	Klucz API nie ma uprawnień do tego zasobu.
500	Błąd serwera	Błąd po stronie serwera. Ponów żądanie lub skontaktuj się z pomocą techniczną.

Reguły walidacji i zachowania#

startDate musi być ≤ endDate. Odwrócony zakres dat zwraca 400 Bad Request.
W jednym żądaniu dozwolona jest tylko jedna wartość grupowania. Podanie wielu wartości zwraca 400 Bad Request.
W jednym żądaniu dozwolony jest tylko jeden typ filtra z dokładnie jedną wartością. Podanie wielu filtrów lub wielu wartości zwraca 400 Bad Request.
Dla wszystkich pól procentowych dzielenie przez zero zwraca 0.0.

Dokumentacja referencyjna

Swagger — Reports web push

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