Server-to-server collection

Interact (authenticated)

Changed on

Push a single event and expect a response from real-time (interactive) upstreams

post/v2/interact

Request

  • Base URL: https://edge.adobedc.net/ee
  • URL: https://edge.adobedc.net/ee/v2/interact
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

datastreamIdstring required

The datastream ID.

requestIdstring uuid

Provide an external request tracing ID; it can also be supplied in the x-request-id header. The Edge Network always appends a 16-character hex entropy suffix to the provided value (or generates a new UUID if none is provided) to guarantee uniqueness across concurrent requests. The returned identifier uses the format <requestId>-<entropy> (for example, 708e4f90-5bff-41c5-8f4b-6c15bab76b11-f46e48eb52594815). Because the entropy suffix is always added, the value in the response always differs from the value supplied in the request. When correlating requests to responses, match on the prefix of the returned requestId rather than an exact string match.

Headers

x-gw-ims-org-idstring

Organization ID

x-request-idstring uuid

Alternate way to supply an external request tracing ID (equivalent to the requestId query parameter). The Edge Network always appends a 16-character hex entropy suffix to the provided value (or generates a new UUID if none is provided) to guarantee uniqueness across concurrent requests. The returned identifier uses the format <x-request-id>-<entropy> (for example, 708e4f90-5bff-41c5-8f4b-6c15bab76b11-f46e48eb52594815). Because the entropy suffix is always added, the value in the response always differs from the value supplied in the request. When correlating requests to responses, match on the prefix of the returned requestId rather than an exact string match.

Cookies

FPIDstring

First Party ID value

Request body

Example request

{
  "query": {
    "identity": {
      "fetch": []
    }
  },
  "event": {
    "xdm": {
      "identityMap": {
        "email": [
          {
            "id": "john.doe@example.com",
            "authenticatedState": "authenticated"
          }
        ]
      },
      "environment": {
        "type": "browser",
        "browserDetails": {
          "name": "Chrome",
          "version": "63.0.3239",
          "acceptLanguage": "en",
          "cookiesEnabled": true,
          "javaScriptEnabled": true,
          "javaScriptVersion": "1.8.5",
          "javaEnabled": true,
          "javaVersion": "Java SE 8",
          "viewportHeight": 900,
          "viewportWidth": 1680
        },
        "colorDepth": 16777216,
        "viewportHeight": 667,
        "viewportWidth": 375
      },
      "device": {
        "typeID": "TypeIdentifier-111",
        "typeIDService": "https://ns.adobe.com/xdm/external/deviceatlas",
        "type": "mobile",
        "manufacturer": "Apple",
        "model": "iPhone Xs",
        "modelNumber": "A1586",
        "screenHeight": 667,
        "screenWidth": 375,
        "colorDepth": 16777216,
        "screenOrientation": "portrait"
      },
      "application": {
        "id": "A123",
        "name": "Myapp",
        "version": "1.0.1",
        "launches": {
          "value": 1
        }
      },
      "placeContext": {
        "localTime": "2001-07-04T12:08:56+01:00",
        "localTimezoneOffset": -360,
        "geo": {
          "countryCode": "JP",
          "stateProvince": "JP-13",
          "city": "Tōkyō",
          "postalCode": "141-0032"
        }
      },
      "web": {
        "webPageDetails": {
          "siteSection": "Product section",
          "server": "example.com",
          "name": "product home",
          "URL": "https://www.example.com"
        },
        "webReferrer": {
          "URL": "https://www.adobe.com/index2.html",
          "type": "external"
        }
      },
      "commerce": {
        "order": {
          "purchaseID": "123",
          "priceTotal": 100,
          "currencyCode": "USD"
        },
        "purchases": {
          "value": 34
        }
      },
      "eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15",
      "eventType": "view:load",
      "timestamp": "2017-09-26T15:52:25+00:00"
    },
    "data": {
      "key1": [
        "value1"
      ],
      "key2": [
        "value2",
        "value3"
      ]
    }
  },
  "meta": {
    "state": {
      "entries": []
    }
  }
}

Response

Successfully processed

requestIdstring required

The entropy-augmented identifier for this request, in the format <requestId>-<entropy> (for example, 708e4f90-5bff-41c5-8f4b-6c15bab76b11-f46e48eb52594815). If a requestId was supplied in the request it is used as the prefix; otherwise a generated UUID is used. This value always differs from any caller-supplied requestId. Match on the prefix when correlating requests to responses.

Example response

{
  "handle": [
    {
      "eventIndex": 0,
      "type": "state:store",
      "payload": [
        {
          "key": "kndctr_53A16ACB5CC1D3760A495C99_AdobeOrg_optout",
          "value": "",
          "maxAge": 7200
        }
      ]
    }
  ]
}

Changes

  • 425966a96c66Revision changes
    • info

      api tag Server-to-server collection added

    • info

      api tag Server event collection removed

  • d8182522d23aRevision changes
    • breaking

      added the new required query request parameter datastreamId

    • warning

      deleted the query request parameter dataStreamId