Adobe Experience Platform Edge Network API (1.0.0)

Download OpenAPI specification:Download

API reference for the Adobe Experience Platform Edge Network API.

Client-to-server collection

Real-time events originating client-side, such as browsers or mobile devices

Interact (non-authenticated)

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

Request
query Parameters
configId
required
string
Default: "8888888"

The datastream ID. The v1 APIs use configId instead of datastreamId.

requestId
string <uuid>

Provide an external request tracing ID; it can also be supplied in the x-request-id header. If none is provided, the API generates one for you and return it back in the response body / headers.

cookie Parameters
FPID
string

First Party ID value

header Parameters
x-request-id
string <uuid>
Request Body schema:
object (XdmContextData)

Property that holds the xdm context data

object (EventQuery)

Explicit request / Server-side Decisioning Override

required
Array of objects (BatchV1Event)
object (RequestMetadata)

Metadata passed to solutions and to the API itself with possibility of overriding at event level

Responses
200

Successfully processed. The event has been received and processed in order.

400

Invalid input.

500

Internal error.

post/v1/interact
Request samples
{
  • "xdm": {
    },
  • "query": {
    },
  • "events": [
    ],
  • "meta": {
    }
}
Response samples
application/json
{
  • "requestId": "string",
  • "handle": [
    ]
}

Collect (non-authenticated)

Push multiple events without expecting a response content. Events can come from different end-users.

Request
query Parameters
configId
required
string
Default: "8888888"

The datastream ID. The v1 APIs use configId instead of datastreamId.

requestId
string <uuid>

Provide an external request tracing ID; it can also be supplied in the x-request-id header. If none is provided, the API generates one for you and return it back in the response body / headers.

cookie Parameters
FPID
string

First Party ID value

header Parameters
x-request-id
string <uuid>
Request Body schema:
object (XdmContextData)

Property that holds the xdm context data

object (EventQuery)

Explicit request / Server-side Decisioning Override

required
Array of objects (BatchV1Event)
object (RequestMetadata)

Metadata passed to solutions and to the API itself with possibility of overriding at event level

Responses
204

Successfully processed. All the events have been received and processed in order.

400

Invalid input.

500

Internal error.

post/v1/collect
Request samples
{
  • "xdm": {
    },
  • "query": {
    },
  • "events": [
    ],
  • "meta": {
    }
}

Fetch the identities specified in the passed namespaces.

Acquire identity

Request
query Parameters
configId
required
string
Default: "8888888"

The datastream ID. The v1 APIs use configId instead of datastreamId.

requestId
string <uuid>

Provide an external request tracing ID; it can also be supplied in the x-request-id header. If none is provided, the API generates one for you and return it back in the response body / headers.

header Parameters
x-request-id
string <uuid>
Request Body schema: application/json
object
object
object (RequestMetadata)

Metadata passed to solutions and to the API itself with possibility of overriding at event level

Responses
200

Successfully processed. An identity has been fetched and is present in the response payload.

400

Invalid input.

500

Internal error.

post/v1/identity/acquire
Request samples
application/json
{
  • "xdm": {
    },
  • "query": {
    },
  • "meta": {
    }
}
Response samples
application/json
{
  • "requestId": "string",
  • "handle": [
    ]
}

Server-to-server collection

Real-time events forwarded by a private server

Interact (authenticated)

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

SecurityApiKeyAuth or IMSAuth
Request
query Parameters
datastreamId
required
string
Default: "8888888"

The datastream ID.

requestId
string <uuid>

Provide an external request tracing ID; it can also be supplied in the x-request-id header. If none is provided, the API generates one for you and return it back in the response body / headers.

cookie Parameters
FPID
string

First Party ID value

header Parameters
x-gw-ims-org-id
string

Organization ID

x-request-id
string <uuid>
Request Body schema: application/json
object (EventQuery)

Explicit request / Server-side Decisioning Override

required
object (SingleEvent)

Represents the single event sent in a request

object (RequestMetadata)

Metadata passed to solutions and to the API itself with possibility of overriding at event level

Responses
200

Successfully processed

400

Invalid input.

403

Request Forbidden.

500

Internal error.

post/v2/interact
Request samples
application/json
{
  • "query": {
    },
  • "event": {
    },
  • "meta": {
    }
}
Response samples
application/json
{
  • "requestId": "string",
  • "handle": [
    ]
}

Collect (authenticated)

Push multiple events without expecting a response content. Events can come from different end-users.

SecurityApiKeyAuth or IMSAuth
Request
query Parameters
datastreamId
required
string
Default: "8888888"

The datastream ID.

requestId
string <uuid>

Provide an external request tracing ID; it can also be supplied in the x-request-id header. If none is provided, the API generates one for you and return it back in the response body / headers.

silent
boolean
Default: false

Optional boolean parameter indicating whether the API returns 204 No Content with an empty payload or not. Critical errors are reported using the corresponding HTTP Status Code and payload, however. Applicable to /v2/collect API only.

header Parameters
x-gw-ims-org-id
string

Organization ID

x-request-id
string <uuid>
Request Body schema: application/json
object (EventQuery)

Explicit request / Server-side Decisioning Override

required
Array of objects (BatchV2Event)
object (RequestMetadata)

Metadata passed to solutions and to the API itself with possibility of overriding at event level

Responses
202

Successfully processed. All the events have been received and processed in order.

204

No content. When the silent parameter is set to true and there were no critical errors.

400

Invalid input.

403

Request Forbidden.

500

Internal error.

post/v2/collect
Request samples
application/json
{
  • "query": {
    },
  • "events": [
    ],
  • "meta": {
    }
}
Response samples
application/json
{
  • "requestId": "string"
}

Profile updates

Collect specific data for Platform profile(s)

Set consent (non-authenticated)

Manage explicit consent for marketing activities. All consent preferences previously saved in the user's profile(s) are overwritten through this operation.

Request
query Parameters
configId
required
string
Default: "8888888"

The datastream ID. The v1 APIs use configId instead of datastreamId.

requestId
string <uuid>

Provide an external request tracing ID; it can also be supplied in the x-request-id header. If none is provided, the API generates one for you and return it back in the response body / headers.

header Parameters
x-request-id
string <uuid>
Request Body schema: application/json
object (IdentityMap)

Defines a map containing a set of end user identities, keyed on either namespace integration code or the namespace ID of the identity. Within each namespace, the identity is unique. The values of the map are an array, meaning that more than one identity of each namespace may be carried. For more details, see IdentityMap Schema.

Array of AdobeConsent (object) or AdobeConsent (object) or AdobeConsent (object)
object (RequestMetadata)

Metadata passed to solutions and to the API itself with possibility of overriding at event level

Responses
200

Successfully processed. Consent preferences are successfully saved for the supplied profile(s).

400

Invalid input.

500

Internal error.

post/v1/privacy/set-consent
Request samples
application/json
{
  • "identityMap": {
    },
  • "consent": [
    ],
  • "meta": {
    }
}
Response samples
application/json
{
  • "requestId": "string",
  • "handle": [
    ]
}