We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/personal/read

Retrieves the data associated with a reader/device identity in a customer account, to fulfill a data subject's right to access their personal data under the GDPR.

Format of the returned data can change in the future.

Request

The request object has the following fields:

Name

Type

Required

Description

userId

String

Yes

Identifies the user whose user profile should be returned.

type

String

Yes

The type of the user identifier, which tells us how to interpret the id. The value cx indicates a Cxense-specific identifier, either an internal cross-site user id returned from an API such as

/traffic/data

, or a site-specific id obtained from cX.getUserId() function call from cx.js. Customer-specific identifiers via a customer-assigned prefix are also possible.

Response

Structured JSON object. The response contains all data associated with the specified user. In particular information about user's profiles, external identities, user's segments, page view and dmp events. The structure of the response object is subject to change without any notice. No tools should be built on top of it.

Examples

Bash
$ python cx.py /personal/read '{"userId":"134483293348982983x7","type":"cx"}'
{
 "profile" :[
 {
 "groups": [
 {
 "group":"xyz-cars",
 "weight":0.8671875
 }
 ],
 "item": "toyota"
 },
 {
 "groups": [
 {
 "group":"xyz-location",
 "weight":0.96875
 },
 {
 "group":"xyz-product",
 "weight":0.96875
 }
 ],
 "item": "granada"
 }],
 "externalProfile" : [
 {
 "group": "xyz-gender",
 "item": "male"
 },
 {
 "group": "xyz-interests",
 "item": "cooking"
 }],
 "identities": [
 {
 "id": "CRM91595539",
 "type": "cxd"
 },
 { 
 "id": "134483293348982983x7",
 "type": "cx"
 }],
 "pageviewEvents": [
 {
 "time": 1443005573,
 "eventId": 921814992,
 "customParameters": [
 {
 "group": "cx_source",
 "item": "cxrecs"
 }],
 "url": "https://example.com/frontpage"
 }],
 "dmpEvents": [
 {
 "time": 1443005573,
 "eventId": 499292181, 
 "pageViewEventId": 921814992,
 "customParameters": [
 {
 "group": "product",
 "item": "615"
 },
 {
 "group": "category",
 "item": "Digital Camera"
 }],
 "type": "addToCart"
 }]
}

Last updated: