DocumentationExperience PlatformEdge Network Server API Documentation

Interactive data collection

Last update: Wed Apr 24 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

Overview overview

Interactive data collection endpoints receive a single event and are used when the client expects a response to be returned by the Adobe Experience Platform Edge Network server. These endpoints can also return content from other Edge Network services, while performing data collection.

IMPORTANT
The /interact endpoint is designed primarily to be used by the Experience Platform SDKs. This endpoint is subject to additive changes and its behavior can evolve without notice. For example, new items might be added to the response payload in the future.

The server response includes one or more Handle objects, as shown below.

API call example

API format format

POST /ee/v2/interact

Request request

curl -X POST "https://server.adobedc.net/ee/v2/interact?dataStreamId={DATASTREAM_ID}"
-H "Authorization: Bearer {TOKEN}"
-H "x-gw-ims-org-id: {ORG_ID}"
-H "x-api-key: {API_KEY}"
-H "Content-Type: application/json"
-d '{
   "event": {
      "xdm": {
         "identityMap": {
            "Email_LC_SHA256": [
               {
                  "id": "0c7e6a405862e402eb76a70f8a26fc732d07c32931e9fae9ab1582911d2e8a3b",
                  "primary": true
               }
            ]
         },
         "eventType": "web.webpagedetails.pageViews",
         "web": {
            "webPageDetails": {
               "URL": "https://alloystore.dev/",
               "name": "home-demo-Home Page"
            }
         },
         "timestamp": "2021-08-09T14:09:20.859Z"
      },
      "data": {
         "prop1": "custom value"
      }
   }
}'
Parameter
Type
Required
Description
dataStreamId
String
Yes.
Datastream ID.
requestId
String
No
Provide a client random ID for correlating internal server requests. If none is provided, the Edge Network will generate one and return it in the response.

Response response

A successful response returns HTTP status 200 OK, with one or more Handle objects, depending on the real-time edge services enabled in the datastream configuration.

{
   "requestId": "c85402f5-83a1-4fb3-abdd-f4c17bf6dd49",
   "handle": []
}
recommendation-more-help
f36c2cef-1417-40aa-a11d-5d0abaee121b