Raporty – atrybucja zamówień

Ta metoda zwraca listę zamówień, które ECDP przypisał do konkretnych wiadomości marketingowych w wybranym zakresie dat.

Każdy rekord (zestaw danych) zawiera informacje o zamówieniu, kliencie, kanale i wiadomości, które doprowadziły do konwersji, oraz wartość zamówienia zarówno w oryginalnej walucie, jak i w walucie raportowania jednostki biznesowej. Użyj tej metody, aby weryfikować poprawność atrybucji, uzgadniać przychody i analizować skuteczność kampanii w kanałach e-mail, SMS i web push.

Endpoint

Adres serwera dla tego zapytania to https://api.ecdp.app/reports/attribution/orders

Parametry zapytania

Odpowiedź

Odpowiedź zawiera tablicę data. Każdy element reprezentuje jedno przypisane zamówienie.

Report data

Customer data

Obiekt customer zawiera następujące pola.

Wartość i podsumowanie zamówienia#

Order attributes

orderAttributes to tablica par { name, value } zawierająca niestandardowe cechy zamówienia (np. kody kuponów lub metody wysyłki). Pole jest pomijane, gdy żadne cechy nie są zdefiniowane.

Order details

Gdy includeDetails=true, każde zamówienie zawiera tablicę orderDetails z pozycjami produktów.

Recommendation attribution – atrybucja rekomendacji

Kody odpowiedzi

Przykładowe zapytania i odpowiedzi

Raport zbiorczy dla konkretnej strony i kanału komunikacji

GET /reports/attribution/orders?startDate=2025-03-01&endDate=2025-03-07&websiteId=21&channel=Email

Odpowiedź (200 OK):

{
  "data": [
    {
      "orderId": "100042",
      "orderDateTime": "2025-03-03T11:24:15Z",
      "websiteId": 21,
      "channel": "Email",
      "messageType": "Newsletter",
      "messageId": 12045,
      "customer": { "id": 981245, "email": "anna@poczta.pl", "phone": "", "crmId": "778" },
      "orderValueConverted": 249.99,
      "originalTotalValue": 249.99,
      "originalCurrency": "PLN",
      "productsCount": 3
    },
    {
      "orderId": "100057",
      "orderDateTime": "2025-03-05T19:02:41Z",
      "websiteId": 21,
      "channel": "Email",
      "messageType": "Scenario",
      "messageId": 11880,
      "customer": { "id": 771100, "email": "jan@poczta.pl", "phone": "", "crmId": "101" },
      "orderValueConverted": 89.99,
      "originalTotalValue": 89.99,
      "originalCurrency": "PLN",
      "productsCount": 1
    }
  ]
}

Raport filtrowany według wiadomości, z pozycjami produktów

GET /reports/attribution/orders?startDate=2025-03-15&endDate=2025-03-15&channel=WebPush&messageType=Newsletter&messageId=9021&websiteId=21&includeDetails=true

Odpowiedź (200 OK):

{
  "data": [
    {
      "orderId": "100042",
      "orderDateTime": "2025-03-15T09:41:06Z",
      "websiteId": 21,
      "channel": "WebPush",
      "messageType": "Newsletter",
      "messageId": 9021,
      "customer": { "id": 332100, "email": "", "phone": "", "crmId": "551" },
      "orderValueConverted": 142.70,
      "originalTotalValue": 142.70,
      "originalCurrency": "PLN",
      "productsCount": 2,
      "orderAttributes": [
        { "name": "kupon", "value": "LATO10" }
      ],
      "orderDetails": [
        {
          "id": "SKU-101",
          "name": "Torba shopperka",
          "price": 39.90,
          "quantity": 1,
          "category": "Torby",
          "productAttributes": [{ "name": "color", "value": "naturalny" }]
        },
        {
          "id": "SKU-225",
          "name": "Butelka na wodę",
          "price": 102.80,
          "quantity": 1,
          "returned": 1,
          "category": "Akcesoria",
          "recommendationAttribution": {
            "scope": "Onsite",
            "type": "Bestsellery",
            "id": 12,
            "channel": "Banner"
          }
        }
      ]
    }
  ]
}

Reguły walidacji i zachowania#

• startDate i endDate są wymagane. startDate musi być wcześniejszy lub równy endDate.
• channel jest wymagany, gdy podano messageId.
• Wartość Confirmation parametru messageType jest prawidłowa wyłącznie gdy channel=Email.
• Każdy parametr filtra przyjmuje dokładnie jedną wartość. Powtórzenie tego samego parametru lub podanie pustej wartości zwraca błąd ‘400 Bad Request’.
• includeDetails przyjmuje wyłącznie wartości true lub false. Każda inna wartość zwraca błąd ‘400 Bad Request’.
• Gdy żadne zamówienia nie spełniają kryteriów zapytania, endpoint zwraca ‘204 No Content’.

Dokumentacja referencyjna#

Swagger — Raport atrybucji zamówień

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