Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Real-time Customer Profile API (1.0)

Download OpenAPI specification:Download

Use Real-time Customer Profile to drive coordinated, consistent and relevant experiences for your customers no matter where or when they interact with your brand. Profile provides a holistic view of each individual customer that combines data from multiple channels, including online, offline, CRM, and third-party data.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Computed attributes

Computed attributes enable a field value to be automatically computed based on other values, calculations, and expressions. Computed attributes functionality is in beta and is not available to all users. Functionality is subject to change. For more information on using this set of endpoints, please read the computed attributes endpoint guide.

List all computed attributes

Request
query Parameters
limit
string

A parameter that specifies the maximum number of items returned as part of the response.

Example: limit=20
offset
string

A parameter that specifies the number of items to skip before returning the items.

Example: offset=5
sortBy
string

A parameter that specifies the order in which the items are sorted. Possible values include name, status, updateEpoch, and createEpoch. You can choose whether to sort in ascending order or descending order by including or not including a - in front of the sort option. By default, the items will be sorted by updateEpoch in descending order.

Enum: "name" "status" "updateEpoch" "createEpoch"
Example: sortBy=-name
property
string

A parameter that lets you filter on various computed attribute fields. Supported values include name, createdEpoch, mergePolicy.value, updateEpoch, and `status. More information about this query parameter can be found in the computed attributes API guide.

Enum: "name" "createdEpoch" "mergePolicy.value" "updateEpoch" "status"
Example: property=name=testingrelease
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

500

Internal server error

502

Service unavailable

get/ca/attributes
Response samples
application/json
{
  • "_page": {
    },
  • "children": [
    ],
  • "_links": {
    }
}

Create a computed attribute

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Request Body schema: application/json
required

A JSON object containing the details of the computed attribute being created.

  • name: The name of the computed attribute field, as a string. The name of the computed attribute can only be comprised of alphanumeric characters without any spaces or underscores.
  • description: A description of the computed attribute.
  • displayName: The display name for the computed attribute. This is the name that will be displayed when listing your computed attributes within the Adobe Experience Platform UI.
  • expression: An object containing information about the expression for the computed attribute.
    • type: The type of expression. Currently, only PQL is supported.
    • format: The format of the expression. Currently, only pql/text is supported.
    • value: The value of the query expression.
  • keepCurrent:* A boolean that determines whether or not the computed attribute's value is kept up-to-date with fast refresh.
  • duration: An object containing the duration of the lookback period for the computed attribute. The lookback period represents how far back can be looked back to compute the computed attribute.
    • count: A number that represents the duration for the lookback period. The possible values depend on the value of the duration.unit field.
      Unit Values
      HOURS 1 - 24
      DAYS 1 - 7
      WEEKS 1 - 4
      MONTHS 1 - 6
    • unit: A string that represents the unit of time that will be used for the lookback period. Possible values include: HOURS, DAYS, WEEKS, and MONTHS.
  • status: The status of the computed attribute. Possible values include DRAFT and NEW.
name
required
string
description
required
string
displayName
required
string
required
object

A valid Profile Query Language (PQL) expression.

keepCurrent
boolean

A boolean that determines whether or not the value should be kept up-to-date using fast refresh.

required
object
status
required
string
Enum: "DRAFT" "NEW"
Responses
200

Success

400

Bad request

500

Internal server error

503

Service unavailable

post/ca/attributes
Request samples
application/json
{
  • "name": "sampleComputedAttribute",
  • "description": "A sample computed attribute",
  • "displayName": "Sample Computed Attribute",
  • "expression": {
    },
  • "keepCurrent": false,
  • "duration": {
    },
  • "status": "DRAFT"
}
Response samples
application/json
{
  • "id": "2afcf410-450e-4a39-984d-2de99ab58877",
  • "type": "ComputedAttribute",
  • "name": "sampleComputedAttribute",
  • "displayName": "Sample Computed Attribute",
  • "description": "Sample description for a computed attribute",
  • "imsOrgId": "{ORG_ID}",
  • "sandbox": {
    },
  • "path": "{TENANT_ID}/ComputedAttributes",
  • "positionPath": [
    ],
  • "keepCurrent": false,
  • "expression": {
    },
  • "mergeFunction": {
    },
  • "status": "DRAFT",
  • "schema": {
    },
  • "lastEvaluationTs": "2023-08-27T00:14:55.028",
  • "returnSchema": {
    },
  • "definedOn": [],
  • "createEpoch": 1572555223,
  • "updateEpoch": 1572555225,
  • "createdBy": "{USER_ID}"
}

Retrieve a specific computed attribute

Request
path Parameters
ATTRIBUTE_ID
required
string

The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

404

Not found

500

Internal server error

503

Service unavailable

get/ca/attributes/{ATTRIBUTE_ID}
Response samples
application/json
{
  • "id": "2afcf410-450e-4a39-984d-2de99ab58877",
  • "type": "ComputedAttribute",
  • "name": "sampleComputedAttribute",
  • "displayName": "Sample Computed Attribute",
  • "description": "Sample description for a computed attribute",
  • "imsOrgId": "{ORG_ID}",
  • "sandbox": {
    },
  • "path": "{TENANT_ID}/ComputedAttributes",
  • "positionPath": [
    ],
  • "keepCurrent": false,
  • "expression": {
    },
  • "mergeFunction": {
    },
  • "status": "DRAFT",
  • "schema": {
    },
  • "lastEvaluationTs": "2023-08-27T00:14:55.028",
  • "returnSchema": {
    },
  • "definedOn": [],
  • "createEpoch": 1572555223,
  • "updateEpoch": 1572555225,
  • "createdBy": "{USER_ID}"
}

Delete a computed attribute

Request
path Parameters
ATTRIBUTE_ID
required
string

The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
202

Accepted

404

Not found

422

Cannot delete

500

Internal server error

503

Service unavailable

delete/ca/attributes/{ATTRIBUTE_ID}
Response samples
application/json
{
  • "id": "2afcf410-450e-4a39-984d-2de99ab58877",
  • "type": "ComputedAttribute",
  • "name": "sampleComputedAttribute",
  • "displayName": "Sample Computed Attribute",
  • "description": "Sample description for a computed attribute",
  • "imsOrgId": "{ORG_ID}",
  • "sandbox": {
    },
  • "path": "{TENANT_ID}/ComputedAttributes",
  • "positionPath": [
    ],
  • "keepCurrent": false,
  • "expression": {
    },
  • "mergeFunction": {
    },
  • "status": "DRAFT",
  • "schema": {
    },
  • "lastEvaluationTs": "2023-08-27T00:14:55.028",
  • "returnSchema": {
    },
  • "definedOn": [],
  • "createEpoch": 1572555223,
  • "updateEpoch": 1572555225,
  • "createdBy": "{USER_ID}"
}

Update a computed attribute

Request
path Parameters
ATTRIBUTE_ID
required
string

The unique, read-only ID of the computed attribute that is generated by the system when the attribute is created.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Request Body schema: application/json
required

Add the key/value pairs of the items you want to update.

status
string
Responses
200

Accepted

404

Not found

500

Internal server error

503

Service unavailable

patch/ca/attributes/{ATTRIBUTE_ID}
Request samples
application/json
{
  • "status": "DRAFT"
}
Response samples
application/json
{
  • "id": "2afcf410-450e-4a39-984d-2de99ab58877",
  • "type": "ComputedAttribute",
  • "name": "sampleComputedAttribute",
  • "displayName": "Sample Computed Attribute",
  • "description": "Sample description for a computed attribute",
  • "imsOrgId": "{ORG_ID}",
  • "sandbox": {
    },
  • "path": "{TENANT_ID}/ComputedAttributes",
  • "positionPath": [
    ],
  • "keepCurrent": false,
  • "expression": {
    },
  • "mergeFunction": {
    },
  • "status": "DRAFT",
  • "schema": {
    },
  • "lastEvaluationTs": "2023-08-27T00:14:55.028",
  • "returnSchema": {
    },
  • "definedOn": [],
  • "createEpoch": 1572555223,
  • "updateEpoch": 1572555225,
  • "createdBy": "{USER_ID}"
}

Entities

An entity is an Experience Data Model (XDM) object whose attributes and related time-series events have been merged from various sources to form an individual profile. For more information on using this set of endpoints, please read the entities endpoint guide.

Retrieve an entity

Request
query Parameters
schema.name
required
string

The name of the schema you want to retrieve.

Enum: "_xdm.context.profile" "_xdm.context.experienceevent" "_xdm.context.account" "_xdm.context.opportunity"
Example: schema.name=_xdm.context.profile
relatedSchema.name
string

If schema.name is "_xdm.context.experienceevent", this value must specify the schema for the profile entity that the time series events are related to. For example, relatedSchema.name=_xdm.context.profile

Example: relatedSchema.name=_xdm.context.profile
entityId
string

The ID of the entity. If the value of this parameter is not an XID, you must also provide the identity namespace parameter, entityIdNS.

Example: entityId=GtghAUFkdGVzdDE
entityIdNS
string

The identity namespace of the entity. This field is only used if you specified an entityId.

Example: entityIdNS=UPS1
relatedEntityId
string

The ID of the entity that the ExperienceEvents are associated with. If schema.name is _xdm.context.experienceevent, this value must specify the related profile entity's identity namespace. This value follows the same rules as entityId.

Example: relatedEntityId=GtghAUFkdGVzdDE
relatedEntityIdNS
string

If schema.name is "_xdm.context.experienceevent", this value must specify the identity namespace for the entity specified in relatedEntityId.

Example: relatedEntityIdNS=UPS1
fields
string

Filters the data returned in the response. Use this to specify which schema field values to include in data retrieved. For multiple fields, separate values by a comma with no spaces between.

Example: fields=person.name.firstName,person.name.lastName
mergePolicyId
string

Identifies the merge policy by which to govern the data returned. If one is not specified in the call, your organization's default for that schema will be used. If no default merge policy has been configured, the default is no profile merge and no identity stitching.

Example: mergePolicyId=example-mergePolicy
startTime
number

Inclusively specifies the start time to filter the entities (in milliseconds). By default, this is from beginning.

Example: startTime=1539838505
endTime
number

Exclusively specifies the end time to filter entities (in milliseconds). By default, this is to the end.

Example: endTime=1539838510
limit
number

The maximum number of records to return from the result. Only for time-series objects. By default, this value is set to 1000.

Example: limit=10
orderby
string

The sort order of retrieved entities by timestamp. This is written as (+/-)timestamp, with the default being +timestamp.

Example: orderby=-timestamp
property
string

Filter by the property value. Supported evaluators include =, !=, <, <=, >, >=. If more than one property filter is provided, it needs to be concatenated with &. This can only be used with experience events, with a maximum of three properties being supported. When using URLs, they must be encoded. When using date filters, they must be encoded as a string in the format "yyyy-mm-dd" or "yyyymmdd".

Example: property=web.webPageDetails.isHomepage=false&property=placeContext.localTime<="2020-07-20"

Example: property=property=web.webPageDetails.isHomepage=false&property=placeContext.localTime<="2020-07-20"
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

422

Processing error

429

Rate limit

500

Internal server error

get/ups/access/entities
Response samples
application/json
{
  • "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
    }
}

Retrieve multiple entities

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Content-Type
required
string

Type of content being sent in the body of the request. Should be 'application/json'.

Request Body schema: application/json
required

XDM objects to be created. Each object should be in JSON format.

required
object (SchemaEntity)
object

If schema.name is "_xdm.context.experienceevent", relatedSchema.name value must specify the schema for the profile entity that the time series events are related to. For example, _xdm.context.profile.

fields
Array of strings

Fields for the model object. By default, all fields will be fetched. Separated by comma.

required
Array of objects (PostIdentityEntityItem)
object (PostTimeFilterEntity)
limit
number

Number of records to return from the result. Only for ExperienceEvents. Default: 1000

orderBy
string

The sort order of retrieved ExperienceEvents by timestamp. Syntax: (+/-)timestamp. Default: +timestamp

Responses
200

Success

207

Partial failure

400

Bad request

403

Missing access permissions

404

Not found

429

Rate limit

500

Internal server error

post/ups/access/entities
Request samples
application/json
{
  • "schema": {
    },
  • "fields": [
    ],
  • "identities": [
    ],
  • "timeFilter": {
    },
  • "limit": 10,
  • "orderBy": "-timestamp"
}
Response samples
application/json
{
  • "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
    },
  • "A29cgveD5y64ezphxjUXNzcm": {
    }
}

Delete an entity

Request
query Parameters
schema.name
required
string

Name of the associated XDM schema. You can only use the _xdm.context.profile schema with this endpoint.

Example: schema.name=_xdm.context.profile
entityId
string

ID of the entity. For Native XID, use entityId=<XID> and leave entityIdNS absent; For ID:NS, use both entityId and entityIdNS fields.

Example: entityId=GtghAUFkdGVzdDE
entityIdNS
string

Identity Namespace code. Used for ID:NS. If this field is used, entityId cannot be empty.

Example: entityIdNS=ECID
mergePolicyId
string

ID of the merge policy. A merge policy includes information for Identity stitching and key-value XDM object merging. If not present, the default merge policy will be used.

Example: mergePolicyId=963d71a1-9875-4aea-a52b-c5c7a2504cae
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
202

Accepted

207

Partial failure

400

Bad request

403

Missing access permissions

404

Not found

429

Rate limit

500

Internal server error

delete/ups/access/entities
Response samples
application/json
[
  • {
    }
]

Merge policies

Merge policies are the rules that Platform uses to determine how data will be prioritized and what data will be combined to create an individual customer profile. For more information on using this set of endpoints, please read the merge policies endpoint guide.

List merge policies

Request
query Parameters
start
string

Page offset - As per created time of resource

Example: start=2
limit
integer

Page Size

Example: limit=10
orderby
string

The model attribute which will be using for ordering

Example: orderby=value
schema.name
string

Schema class ID

Example: schema.name=_xdm.context.profile
default
boolean

default flag

Example: default=true
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-request-id
string

Request ID

Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA
Responses
200

Success

500

Internal server error

503

Service unavailable

get/ups/config/mergePolicies
Response samples
application/json
{
  • "_page": {
    },
  • "children": [
    ]
}

Create a merge policy

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Content-Type
required
string

Type of content being sent in the body of the request. Should be 'application/json'.

x-profile-instance-id
required
string

Profile Instance ID

Example: ups
x-request-id
string

Request ID

Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA
Request Body schema: application/json
required

The merge policy object

name
string

The name of the merge policy you want to create.

required
object (SchemaClass)

An object that specifies which schema class the merge policy is created for.

default
boolean

A boolean that specifies if the merge policy is the default for the schema.

required
object (IdentityGraph)

The identity graph for the merge policy.

required
object (AttributeMerge)

An object that describes which profile attributes to prioritize in case of conflicting profile attributes.

isActiveOnEdge
boolean

A boolean that specifies if the merge policy will be active on edge.

Responses
200

Success

400

Bad request

403

Missing access permissions

429

Rate limit

500

Internal server error

503

Service unavailable

post/ups/config/mergePolicies
Request samples
application/json
{
  • "name": "real-time-customer-profile-default",
  • "schema": {
    },
  • "default": true,
  • "identityGraph": {
    },
  • "attributeMerge": {
    },
  • "isActiveOnEdge": true
}
Response samples
application/json
{
  • "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
  • "name": "real-time-customer-profile-default",
  • "schema": {
    },
  • "default": true,
  • "identityGraph": {
    },
  • "attributeMerge": {
    },
  • "isActiveOnEdge": true,
  • "version": 1
}

Retrieve a merge policy

Request
path Parameters
mergePolicyId
required
string

Merge policy ID.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-request-id
string

Request ID

Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA
Responses
200

Success

403

Missing access permissions

404

Not found

503

Service unavailable

get/ups/config/mergePolicies/{mergePolicyId}
Response samples
application/json
{
  • "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
  • "name": "real-time-customer-profile-default",
  • "schema": {
    },
  • "default": true,
  • "identityGraph": {
    },
  • "attributeMerge": {
    },
  • "isActiveOnEdge": true,
  • "version": 1
}

Update a merge policy

Request
path Parameters
mergePolicyId
required
string

Merge policy ID.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-profile-instance-id
required
string

Profile Instance ID

Example: ups
x-request-id
string

Request ID

Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA
Request Body schema: application/json
required

merge policy object

id
string

The ID of the merge policy.

name
string

The name of the merge policy you want to create.

required
object (SchemaClass)

An object that specifies which schema class the merge policy is created for.

default
boolean

A boolean that specifies if the merge policy is the default for the schema.

required
object (IdentityGraph)

The identity graph for the merge policy.

required
object (AttributeMerge)

An object that describes which profile attributes to prioritize in case of conflicting profile attributes.

isActiveOnEdge
boolean

A boolean that specifies if the merge policy will be active on edge.

version
integer

The version of the merge policy.

Responses
200

Success

400

Bad request

403

Missing access permissions

429

Rate limit

500

Internal server error

503

Service unavailable

put/ups/config/mergePolicies/{mergePolicyId}
Request samples
application/json
{
  • "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
  • "name": "real-time-customer-profile-default",
  • "schema": {
    },
  • "default": true,
  • "identityGraph": {
    },
  • "attributeMerge": {
    },
  • "isActiveOnEdge": true,
  • "version": 1
}
Response samples
application/json
{
  • "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
  • "name": "real-time-customer-profile-default",
  • "schema": {
    },
  • "default": true,
  • "identityGraph": {
    },
  • "attributeMerge": {
    },
  • "isActiveOnEdge": true,
  • "version": 1
}

Delete a merge policy

Request
path Parameters
mergePolicyId
required
string

Merge policy ID.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-request-id
string

Request ID

Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA
Responses
200

Success

403

Missing access permissions

404

Not found

503

Service unavailable

delete/ups/config/mergePolicies/{mergePolicyId}

Update one or more attributes of a merge policy

Request
path Parameters
mergePolicyId
required
string

Merge policy ID.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-profile-instance-id
required
string

Profile Instance ID

Example: ups
x-request-id
string

Request ID

Example: q0gf6caRuRtX2s5khaN1Zgd1OoEXcPJA
Request Body schema: application/json
required

A sample request body to update the merge policy.

Array
op
required
string

op

Value: "add"
path
required
string

The path of the attribute need to be updated. Supported values include /name, /identityGraph.type, /attributeMerge.type, /schema.name, /version, /default, and /idActiveOnEdge.

value
required
string

The new value used to update the specified attribute

Responses
200

Success

400

Bad request

403

Missing access permissions

429

Rate limit

500

Internal server error

503

Service unavailable

patch/ups/config/mergePolicies/{mergePolicyId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "10648288-cda5-11e8-a8d5-f2801f1b9fd1",
  • "name": "real-time-customer-profile-default",
  • "schema": {
    },
  • "default": true,
  • "identityGraph": {
    },
  • "attributeMerge": {
    },
  • "isActiveOnEdge": true,
  • "version": 1
}

Retrieve multiple merge policies using multiple merge policy IDs

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Content-Type
required
string

Type of content being sent in the body of the request. Should be 'application/json'.

Request Body schema: application/json
required

An array of the merge policy IDs that you are trying to retrieve.

Array of objects
Responses
207

Success

post/ups/config/mergePolicies/bulk-get
Request samples
application/json
{
  • "ids": [
    ]
}
Response samples
application/json
{
  • "results": {
    }
}

Profile preview

Preview the latest sample job showing how many profile fragments and merged profiles are in the Profile store, as well as listing profile distribution by dataset and by identity namespace. For more information on using this set of endpoints, please read the profile preview endpoint guide.

Preview the last successful sample job

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

403

Missing access permissions

503

Service unavailable

get/ups/previewsamplestatus
Response samples
application/json
{
  • "numRowsToRead": "41003",
  • "sampleJobRunning": {
    },
  • "docCount": "\"300803\"",
  • "totalFragmentCount": 57429,
  • "lastSuccessfulBatchTimestamp": "string",
  • "streamingDriven": "string",
  • "totalRows": "51003",
  • "lastBatchId": "string",
  • "status": "TASK_FINISHED",
  • "samplingRatio": 0.803933,
  • "mergeStrategy"": "timestampOrdered_auto",
  • "lastSampledTimestamp": "2020-08-01 17:57:57.0"
}

View a report showing the distribution of profiles by dataset

Request
query Parameters
date
string

Specify the date of the report to be returned. If multiple reports were run on the date, the most recent report for that date will be returned. If a report does not exist for the specified date, a 404 error will be returned. If no date is specified, the most recent report will be returned. Format: YYYY-MM-DD. Example: date=2024-12-31

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

404

Not found

503

Service unavailable

get/ups/previewsamplestatus/report/dataset
Response samples
application/json
{
  • "data": [
    ],
  • "reportTimestamp": "2020-08-01T17:57:58.697"
}

View a report showing the distribution of profiles by namespace

Request
query Parameters
date
string

Specify the date of the report to be returned. If multiple reports were run on the date, the most recent report for that date will be returned. If a report does not exist for the specified date, a 404 error will be returned. If no date is specified, the most recent report will be returned. Format: YYYY-MM-DD. Example: date=2024-12-31

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

404

Not found

503

Service unavailable

get/ups/previewsamplestatus/report/namespace
Response samples
application/json
{
  • "data": [
    ],
  • "reportTimestamp": "2020-08-01T17:57:58.697"
}

Profile System Jobs

Profile System Jobs allow you to delete profile fragments for a given dataset or batch. For more information on using this set of endpoints, please read the profile system jobs endpoint guide.

List all delete requests (Profile System Jobs)

Please note that the query parameters can only be used in Microsoft Azure instances of Adobe Experience Platform. To learn more about the supported Experience Platform infrastructure, see the Experience Platform multi-cloud overview.

Request
query Parameters
start
integer

Return results from a specific page offset. For example, start=3

limit
integer

Limit response to a specific number of objects. Must be a positive number. For example, limit=10

page
integer

Return a specific page of results, as per the create time of the request. For example, page=0

sort
string

Sort results by a specific field in ascending (asc) or descending (desc) order. The sort parameter does not work when returning multiple pages of results. For example, sort=batchId:asc

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-sandbox-id
string

The ID of the sandbox you are using. If you are using Platform on Amazon Web Services (AWS), you must use this request header.

Responses
200

Success

403

Missing access permissions

500

Internal server error

503

Service unavailable

get/ups/system/jobs
Response samples
application/json
{
  • "_page": {
    },
  • "children": [
    ]
}

Create delete request (Profile System Job)

Initiating a new delete request is done through a POST request to the /systems/jobs endpoint, where the ID of the dataset or batch to be deleted is provided in the body of the request.

In order to delete a dataset, the dataset ID must be included in the body of the POST request. This action will delete ALL data for a given dataset. Experience Platform allows you to delete datasets based on both record and time series schemas.

In order to delete a batch, the batch ID must be included in the body of the POST request. Please be advised that you cannot delete batches for datasets based on record schemas. Only batches for datasets based on time series schemas may be deleted.

Note: The reason you cannot delete batches for datasets based on record schemas is because record type dataset batches overwrite previous records and therefore cannot be "undone" or deleted. The way to remove the impact of erroneous batches for datasets based on record schemas is to re-ingest the batch with the correct data and it will overwrite the incorrect records.

For more information on record and time series behavior, please review the section on XDM data behaviors in the XDM System overview.

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-sandbox-id
string

The ID of the sandbox you are using. If you are using Platform on Amazon Web Services (AWS), you must use this request header.

Content-Type
required
string

Type of content being sent in the body of the request. Should be 'application/json'.

Request Body schema: application/json
required

A JSON object containing the ID of the dataset or batch to be deleted. Example for batch ID:

{
  "batchId": "8d075b5a178e48389126b9289dcfd0ac"
}
dataSetId
string

dataSetId

Responses
200

Success

400

Invalid

403

Missing access permissions

422

Request already exists

500

Internal server error

503

Service unavailable

post/ups/system/jobs
Request samples
application/json
{
  • "dataSetId": "5cf212ed73fbff145365d15d"
}
Response samples
application/json
{
  • "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
  • "imsOrgId": "{ORG_ID}",
  • "dataSetId": "5c802d3cd83fc114b741c4b5",
  • "jobType": "DELETE",
  • "status": "NEW",
  • "createEpoch": 1559025404,
  • "updateEpoch": 1559025406
}

Retrieve a delete request (Profile System Job)

Request
path Parameters
ID
required
string

ID of the delete request (Profile System Job) that you wish to view. For example, '3e64ad31-5e6b-4399-80ad-ccfab54254ae'.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

x-sandbox-id
string

The ID of the sandbox you are using. If you are using Platform on Amazon Web Services (AWS), you must use this request header.

Responses
200

Success

403

Missing access permissions

404

Not found

500

Internal server error

503

Service unavailable

get/ups/system/jobs/{ID}
Response samples
application/json
{
  • "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
  • "imsOrgId": "{ORG_ID}",
  • "batchId": "8d075b5a178e48389126b9289dcfd0ac",
  • "jobType": "DELETE",
  • "status": "COMPLETED",
  • "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
  • "createEpoch": 1559026134,
  • "updateEpoch": 1559026137
}

Remove a delete request (Profile System Job)

This endpoint can only be used with the Microsoft Azure instance of Adobe Experience Platform, and cannot be used with the Amazon Web Services (AWS) instance of Platform.

Request
path Parameters
ID
required
string

ID of the delete request (Profile System Job) that you wish to view. For example, '3e64ad31-5e6b-4399-80ad-ccfab54254ae'.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

403

Missing access permissions

404

Not found

503

Service unavailable

delete/ups/system/jobs/{ID}