1. Streaming Events via API

4 min

In this exercise we will use a streaming connection to ingest XDM-formatted JSON records in real-time to the Adobe Experience Platform.

We will use Postman to send these events to the Streaming endpoint.

In our example, we will send a product purchase event to the dataset Demo System - Event Dataset for POS (Global v1.1)

Open Postman and expand the Collection.
Select the POST request Sending Events via Streaming API (Purchase)
Click on Body to see the JSON payload we are sending.

You will see that the payload is in the XDM format as defined by the Schema. We've included:

The product list items array to give context to which product has been viewed.
The timestamp which specifies when the product view event occured.
The event type which is recognised as the product view event in AEP.
The _id which is the unique ID of the event.
The Schema and Dataset IDs for where we want to send the data.

The full payload:

{
      "header": {
          "schemaRef": {
              "id": "https://ns.adobe.com/demopotemea/schemas/dce58aa964d98317c66cfc735a4ec48b646598cd247a8b9b",
              "contentType": "application/vnd.adobe.xed-full+json;version=1.0"
          },
          "imsOrgId": "8AB51935659C10E40A495FA2@AdobeOrg",
          "datasetId": "672a0bfe408da22aee7575c4",
          "source": {
              "name":"Retail Streaming Events"
          }
      },
      "body": {
          "xdmMeta": {
              "schemaRef": {
                  "id": "https://ns.adobe.com/demopotemea/schemas/dce58aa964d98317c66cfc735a4ec48b646598cd247a8b9b",
                  "contentType": "application/vnd.adobe.xed-full+json;version=1.0"
              }
          },
          "xdmEntity": {
            "_demopotemea": {
              "identification": {
                "core": {
                  "loyaltyId": "12fd45tg"
                }
              },
              "interactionDetails": {
                "core": {
                  "channel": "api"
                }
              }
            },
            "_id": "wk1hsz97v160632289959130",
            "commerce": {
              "productViews": {
                "value": 1
              }
            },
            "environment": {
              "type": "external"
            },
            "eventType": "commerce.purchases",
            "implementationDetails": {
              "environment": "server",
              "name": "https://ns.adobe.com/experience/alloy",
              "version": "1.2"
            },
            "productListItems": [{
                "SKU": "77045672",
                "name": "Straight-fit coat with buttons",
                "quantity": 1,
                "priceTotal": 340,
                "productAddMethod": "api",
                "_demopotemea": {
                    "core": {
                        "description": "Wool mix fabric. Heavy structure. Medium design. Straight design. Shirt-style collar.",
                        "mainCategory": "Womens coats"
                    }
                }
            }],
            "timestamp": "2024-11-06T09:20:39+00:00"
          }
      }
  }

Click Send to execute this request and send the event to the Experience Platform.
You will see a response with status 200 OK if the event has been received successfully.

You can now check the Dataset Activity UI to see if your event has been ingested successfully.

Navigate to Datasets from the main left hand navigation.
Click the dataset Demo System - Event Dataset for POS (Global v1.1).
Look in the recent batches for successfully ingested records.
Select Preview Dataset to see what data has been ingested, look for your product view event.

With this, you’ve now successfully ingested product view events to Adobe Experience Platform via the Streaming API!