Get the cluster history of an identity
Identities can move clusters over the course of various device graph runs. Identity Service provides visibility into the cluster associations of a given identity over time.
Use optional graph-type parameter to indicate the output type to get the cluster from. Options are:
None- Perform no identity stitching.Private Graph- Perform identity stitching based on your private identity graph. If nograph-typeis provided, this is the default.
Get the cluster history of a single identity
API format
GET https://platform-{REGION}.adobe.io/data/core/identity/cluster/history
Request
Option 1: Supply the identity as namespace (nsId, by ID) and ID value (id).
curl -X GET \
'https://platform-va7.adobe.io/data/core/identity/cluster/history?nsId=411&id=WTCpVgAAAFq14FMF' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Option 2: Supply the identity as namespace (ns, by name) and ID value (id).
curl -X GET \
'https://platform-va7.adobe.io/data/core/identity/cluster/history?ns=AMO&id=WTCpVgAAAFq14FMF' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Option 3: Supply the identity as XID (xid). For more on how to obtain an identity’s XID, see the section of this document covering getting the XID for an identity.
curl -X GET \
'https://platform-va7.adobe.io/data/core/identity/cluster/history?xid=CJsDEAMaEAHmCKwPCQYNvzxD9JGDHZ8' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Get the cluster history of a multiple identities
Use the POST method as a batch equivalent of the GET method described above to return the cluster histories of multiple identities.
API format
POST https://platform-va7.adobe.io/data/core/identity/clusters/history
Request body
Option 1: Supply a list of XIDs for which to retrieve cluster members.
{
"xids": ["GYMBWaoXbMtZ1j4eAAACepuQGhs","b2NJK9a5X7x4LVE4rUqkMyM"],
"graph-type": "Private Graph"
}
Option 2: Supply a list of identities as composite IDs, where each names the ID value and namespace by namespace code.
{
"compositeXids": [{
"ns": "AdCloud",
"id": "WRbM7AAAAJ_PBZHl"
},
{
"ns": "AddCloud",
"id": "WY-RNgAAArI4rGBo"
}
]
}
Request
Stub request
Usage of x-uis-cst-ctx: stub header will return a stubbed response. This is a temporary solution to facilitate early integration development progress, while services are being completed. This will be deprecated when no longer needed.
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/clusters/history \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-uis-cst-ctx: stub' \
-d '{
"xids": ["GYMBWaoXbMtZ1j4eAAACepuQGhs","b2NJK9a5X7x4LVE4rUqkMyM"],
"graph-type": "Private Graph"
}'
Using XIDs
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/clusters/history \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"xids": ["GYMBWaoXbMtZ1j4eAAACepuQGhs","b2NJK9a5X7x4LVE4rUqkMyM"],
"graph-type": "Private Graph"
}' | json_pp
Using UIDs
curl -X POST \
https://platform-va7.adobe.io/data/core/identity/clusters/history \
-H 'authorization: Bearer {ACCESS_TOKEN}' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"compositeXids": [{
"nsid": 411,
"id": "WRbM7AAAAJ_PBZHl"
},
{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}
],
"graph-type": "Private Graph"
}' | json_pp
Respomse
{
"version": 1,
"xidsClusterHistory": [{
"xid": "GZsBQnHQaGtL46ZKSvO9bNRE1DcUyQA",
"compositeXid": {
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
},
"clusterHistory": [{
"clusterId": "4c686f23-0871-41c2-b4f4-adef89f6bd2c",
"cRecordedTS": "1504741401382"
},
{
"clusterId": "29bf066c-971a-11e7-abc4-cec278b6b50a",
"cRecordedTS": "1502063001629"
},
{
"clusterId": "aeb2f60c-b0f1-446a-91dd-d28ab6a44ff9",
"cRecordedTS": "1499384601763"
}
]
},
{
"xid": "CJsDEAMaEAHmCKwPCQYNvzxD9JGDHZ8",
"compositeXid": {
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
},
"clusterHistory": [{
"clusterId": "4c686f23-0871-41c2-b4f4-adef89f6bd2c",
"cRecordedTS": "1504741401937"
}]
}
],
"unprocessedXids": ["cb0665db616f49758713252d8a335c1e"],
"unprocessedNids": [{
"nsid": 411,
"id": "WY-RNgAAArI4rGBo"
}]
}