Przejdź do treści

Raporty – SMS – raport zbiorczy

Ta metoda zwraca podsumowanie skuteczności kanału SMS dla wybranego okresu. Możesz jej użyć, żeby sprawdzić, jak działają Twoje wiadomości SMS, na przykład:

  • porównać dzienne współczynniki odrzuceń,
  • śledzić trendy kliknięć dla różnych nadawców,
  • sprawdzić, ile przychodów generują Twoje kampanie newsletterowe.

Endpoint

GET /reports/sms/channelSummary

Host: https://api.ecdp.app

Parametry zapytania

ParametrTypWymaganyOpisDozwolone wartości / uwagi
x-api-keystringTakKlucz API do uwierzytelnieniaDostępny w Ustawienia > API
startDatestringTakPoczątek okresu raportowania (włącznie)Format: YYYY-MM-DD
endDatestringTakKoniec okresu raportowania (włącznie)Format: YYYY-MM-DD. Musi być późniejszy niż startDate
groupingenumNiePoziom agregacji wyników. Domyślnie: DateJedna z wartości: Date, Month, Gateway, Sender, Message, MessageType
gatewaystringNieFiltr: uwzględnia tylko zdarzenia wysłane przez wskazaną bramkęPojedyncza wartość. Nie można łączyć z innymi filtrami
senderstringNieFiltr: uwzględnia tylko zdarzenia wysłane przez wskazanego nadawcęPojedyncza wartość. Nie można łączyć z innymi filtrami
messageTypestringNieFiltr: uwzględnia tylko zdarzenia dla wskazanego typu wiadomościNewsletter, Scenario. Pojedyncza wartość

Filtry

Filtry pozwalają zawęzić wyniki do wybranego podzbioru ruchu SMS. Obowiązują następujące zasady:

  • W jednym żądaniu można użyć tylko jednego typu filtru.
  • Każdy filtr przyjmuje dokładnie jedną wartość.
  • Podanie wielu filtrów lub wielu wartości zwraca błąd 400 Bad Request.
  • Filtry działają jako warunek AND w połączeniu z zakresem dat.
FiltrTypOpis
gatewaystringOgranicza wyniki do wskazanej bramki (wartość alfanumeryczna lub numeryczna)
senderstringOgranicza wyniki do wskazanego nadawcy (wartość alfanumeryczna lub numeryczna)
messageTypestringOgranicza wyniki do jednego typu wiadomości SMS: Newsletter lub Scenario

Opcje grupowania#

W jednym żądaniu można podać dokładnie jedną wartość grupowania. Domyślnie: grouping=Date. Podanie wielu wartości grupowania zwraca błąd 400 Bad Request.

Wartość grupowaniaKolumna grupowania w odpowiedzi
Datedate (YYYY-MM-DD)
Monthmonth (YYYY-MM)
Gatewaygateway
Sendersender
MessagemessageId, messageName
MessageTypemessageType

Odpowiedź

Każdy obiekt zawiera dokładnie jedną kolumnę grupowania (zgodnie z wybranym parametrem grouping) oraz poniższe wskaźniki KPI.

PoleTypOpis
sentintegerŁączna liczba wysłanych wiadomości SMS
bouncedintegerLiczba wiadomości, których dostarczenie się nie powiodło
bouncedPercentnumberOdsetek odrzuconych względem wysłanych.
deliveredintegerLiczba skutecznie dostarczonych wiadomości
deliveredPercentnumberOdsetek dostarczonych względem wysłanych.
clicksintegerŁączna liczba kliknięć w linki
clicksPercentnumberOdsetek kliknięć względem dostarczonych.
clickersintegerLiczba unikalnych odbiorców, którzy kliknęli co najmniej jeden link
unsubscribesintegerLiczba odbiorców, którzy zrezygnowali z subskrypcji
revenuenumberPrzychód przypisany do tego ruchu SMS, w domyślnej walucie jednostki biznesowej

Przykładowe zapytania i odpowiedzi

Domyślne grupowanie według daty

GET /reports/sms/channelSummary?startDate=2025-09-01&endDate=2025-09-02

Odpowiedź: OK 200

{
  "data": [
    {
      "date": "2025-09-01",
      "sent": 18000,
      "bounced": 90,
      "bouncedPercent": 0.50,
      "delivered": 17850,
      "deliveredPercent": 99.17,
      "clicks": 820,
      "clicksPercent": 4.59,
      "clickers": 610,
      "unsubscribes": 22,
      "revenue": 2100.00
    },
    {
      "date": "2025-09-02",
      "sent": 16500,
      "bounced": 75,
      "bouncedPercent": 0.45,
      "delivered": 16425,
      "deliveredPercent": 99.55,
      "clicks": 760,
      "clicksPercent": 4.63,
      "clickers": 565,
      "unsubscribes": 18,
      "revenue": 1895.50
    }
  ]
}

 

Grupowanie według nadawcy, z filtrem według typu wiadomości

GET /reports/sms/channelSummary?startDate=2025-09-01&endDate=2025-09-30&grouping=Sender&messageType=Newsletter

Odpowiedź: OK 200

{
  "data": [
    {
      "sender": "SHOP24",
      "sent": 92000,
      "bounced": 540,
      "bouncedPercent": 0.59,
      "delivered": 91460,
      "deliveredPercent": 99.41,
      "clicks": 4120,
      "clicksPercent": 4.50,
      "clickers": 3010,
      "unsubscribes": 190,
      "revenue": 10450.00
    }
  ]
}

Kody odpowiedzi

KodStatusOpis
200SukcesŻądanie zostało przetworzone pomyślnie. Odpowiedź zawiera zagregowane dane SMS.
204Brak treściŻądanie było poprawne, ale żadne dane nie spełniają podanych kryteriów.
400Błędne żądanieNieprawidłowe lub brakujące parametry — na przykład startDate > endDate, wiele filtrów lub nieobsługiwana wartość grupowania.
401Brak autoryzacjiKlucz API jest nieprawidłowy, brakuje go lub wygasł. Sprawdź swój klucz w Ustawienia > API.
403Brak dostępuKlucz API nie ma uprawnień do tego zasobu.
500Błąd serweraBłąd po stronie serwera. Ponów żądanie lub skontaktuj się z pomocą techniczną, jeśli problem się powtarza.

Reguły walidacji i działania

  • startDate musi być wcześniejszy lub równy endDate. Odwrócone daty zwracają błąd 400 Bad Request.
  • W jednym żądaniu dozwolona jest tylko jedna wartość grupowania. Podanie wielu grupowań zwraca błąd 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 błąd 400 Bad Request.
  • Nieobsługiwane lub nierozpoznane wartości parametrów zwracają błąd 400 Bad Request.

Dokumentacja referencyjna

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

Polityka prywatności