DocumentationExperience PlatformEdge Network Server API Documentation

Non-interactive data collection

Last update: Wed Dec 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User
  • Admin
  • Leader

Overview overview

Non-interactive event data collection endpoints are used to send multiple events to Experience Platform datasets or other outlets.

Sending events in batch is recommended when end-user events are queued locally for a short period of time (e.g. when there’s no network connection).

Batch events should not necessarily belong to the same end-user, meaning that events can hold different identities within their identityMap object.

Non-interactive API call example example

API format api-format

POST /ee/v2/collect

Request request

curl -X POST "https://server.adobedc.net/ee/v2/collect?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 '{
   "events": [
      {
         "xdm": {
            "identityMap": {
               "FPID": [
                  {
                     "id": "79bf8e83-f708-414b-b1ed-5789ff33bf0b",
                     "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"
         }
      },
      {
         "xdm": {
            "identityMap": {
               "FPID": [
                  {
                     "id": "871e8460-a329-4e96-a5b6-ff359fb0afb9",
                     "primary": "true"
                  }
               ]
            },
            "eventType": "web.webinteraction.linkClicks",
            "web": {
               "webInteraction": {
                  "linkClicks": {
                     "value": 1
                  }
               },
               "name": "My Custom Link",
               "URL": "https://myurl.com"
            },
            "timestamp": "2021-08-09T14:09:20.859Z"
         }
      }
   ]
}'
Parameter
Type
Required
Description
dataStreamId
String
Yes
The ID of the datastream used by the data collection endpoint.
requestId
String
No
Provide an external request tracing ID. If none is provided, the Edge Network will generate one for you and return it back in the response body / headers.
silent
Boolean
No
Optional boolean parameter indicating whether the Edge Network should return a 204 No Content response with an empty payload or not. Critical errors are reported using the corresponding HTTP status code and payload.

Response response

A successful response returns one of the following statuses, and a requestID if none was provided in the requst.

  • 202 Accepted when the request was successfully processed;
  • 204 No Content when the request was successfully processed and the silent parameter was set to true;
  • 400 Bad Request when the request was not properly formed (e.g., the mandatory primary identity was not found).
{
  "requestId": "f567a988-4b3c-45a6-9ed8-f283188a445e"
}
recommendation-more-help
f36c2cef-1417-40aa-a11d-5d0abaee121b