Reports – order attribution

This method returns a list of orders that ECDP attributed to specific marketing messages within a selected date range.

Each record identifies the order, the customer, the channel and message that drove the conversion, and the order value in both the original and reporting currencies.

Use this method to audit attribution accuracy, reconcile revenue, and analyze campaign performance across email, SMS, and web push channels.

Endpoint

The server address for this request is https://api.ecdp.app/reports/attribution/orders

Request parameters

Response

The response contains a data array. Each element represents one attributed order.

Order attribution report data

Customer data

The customer data contains the following fields.

Order value and summary

Order attributes

orderAttributes is an array of { name, value } pairs carrying order-level custom attributes (for example, coupon codes or shipping methods). The field is omitted when no attributes are present.

Order details

When includeDetails=true, each order includes an orderDetails array of product line items.

Recommendation attribution object

Response codes

Example requests and responses

Get summary report for a specific website and channel

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

Response (200 OK):

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

Get report filtered by message with product line items

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

Response (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": "USD",
      "productsCount": 2,
      "orderAttributes": [
        { "name": "coupon", "value": "SPRING10" }
      ],
      "orderDetails": [
        {
          "id": "SKU-101",
          "name": "Canvas Tote",
          "price": 39.90,
          "quantity": 1,
          "category": "Bags",
          "productAttributes": [{ "name": "color", "value": "natural" }]
        },
        {
          "id": "SKU-225",
          "name": "Water Bottle",
          "price": 102.80,
          "quantity": 1,
          "returned": 1,
          "category": "Accessories",
          "recommendationAttribution": {
            "scope": "Onsite",
            "type": "Bestsellers",
            "id": 12,
            "channel": "Banner"
          }
        }
      ]
    }
  ]
}

Validation and behavior rules#

• startDate and endDate are required. startDate must be earlier than or equal to endDate.
• channel is required when messageId is provided.
• messageType value Confirmation is valid only when channel=Email.
• Each filter parameter accepts exactly one value. Repeating the same parameter or passing an empty value returns ‘400 Bad Request’.
• includeDetails accepts true or false only. Any other value returns ‘400 Bad Request’.
• When no orders match the query, the endpoint returns ‘204 No Content’.

Reference documentation#

Swagger – Reports attribution

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