Serve Personal Data - BloomReach Experience - Open Source CMS

This article covers a Hippo CMS version 12. There's an updated version available that covers our most recent release.

19-10-2017

Serve Personal Data

Prerequisite

This document assumes you have added the Public Relevance REST API. This documents assumes that you have added the API below /gdpr but as explained in Public Relevance REST API, the exact URL you can choose yourself.

Serve Personal Data

Once you have the Public Relevance REST API enabled, a visitor can access their personal data via the GET http request:

/gdpr/visitorinfo
The /gdpr part thus depends on how you added the REST api

To be GDPR compliant, most likely you want to add some button or link to your website through which the visitor will invoke this URL and return the information we have about the visitor.

The output is a JSON result similar to the example below. What is exactly in it depends on the data you are collecting which is domain-specific. If you want a different representation than the default JSON output, you can add a different REST endpoint, see Public Relevance REST API.

Note that by default, we return no more than the last 200 request entries to avoid overwhelming the server, bandwidth or client. If you want a different default, you can achieve so by a adding a different REST endpoint. After a visitor has requested to be forgotten, requesting the /gpdr/visitorinfo again will result in 

{
  "visitor":null,
  "requestLogEntries":null
}

Example Output

{  
   "visitor":{  
      "visitId":"8d12121b-c205-45cb-9f65-f57a9fd6800b",
      "targetingData":{  
         "geo":{  
            "collectorId":"geo",
            "city":"Amsterdam",
            "country":"Netherlands",
            "continent":"Europe",
            "latitude":52.37,
            "longitude":4.89
         },
         "returningvisitor":{  
            "collectorId":"returningvisitor",
            "returningVisitor":false
         },
         "dayofweek":{  
            "collectorId":"dayofweek",
            "lastVisitDayOfWeek":3
         },
         "tracking":{  
            "collectorId":"tracking",
            "visitorConsents":true
         }
      },
      "lastAccessedTime":1502278738276,
      "newVisit":false,
      "new":false,
      "id":"4baa74f5-3137-4774-a3e6-54a73240ef08"
   },
   "requestLogEntries":[  
      {  
         "visitorId":"4baa74f5-3137-4774-a3e6-54a73240ef08",
         "visitId":"8d12121b-c205-45cb-9f65-f57a9fd6800b",
         "newVisit":false,
         "mountId":"2a79f1be-3917-4008-b973-b932e0f25fe2",
         "pageId":"hst:pages/newslist",
         "pageUrl":"http://127.0.0.1:9080/site/news",
         "pathInfo":"/news",
         "referer":"http://127.0.0.1:9080/site/",
         "userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 
                      (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36",
         "timestamp":1502278738276,
         "collectorData":{  
            "geo":{  
               "city":"Amsterdam",             
               "country":"Netherlands",
               "continent":"Europe",
               "latitude":52.37,
               "longitude":4.89
               "location":{  
                  "lat":52.37,
                  "lon":4.89
               }
            },
            "returningvisitor":false,
            "channel":"Hippo Acceptance Project",
            "dayofweek":3,
            "tracking":true,
            "parameters":{},
            "cookies":{  
               "values":{}
            }
         },
         "data":{},
         "experimentSelectedVariantList":null,
         "personaIdScores":[],
         "globalPersonaIdScores":[]
      },
      {  
         "visitorId":"4baa74f5-3137-4774-a3e6-54a73240ef08",
         "visitId":"8d12121b-c205-45cb-9f65-f57a9fd6800b",
         "newVisit":true,
         "mountId":"2a79f1be-3917-4008-b973-b932e0f25fe2",
         "pageId":"hst:pages/homepage",
         "pageUrl":"http://127.0.0.1:9080/site/",
         "pathInfo":"",
         "referer":null,
         "userAgent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 
                      (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36",
         "timestamp":1502278689350,
         "collectorData":{  
            "geo":{  
               "city":"Amsterdam",
               "country":"Netherlands",
               "continent":"Europe",
               "latitude":52.37,
               "longitude":4.89
               "location":{  
                  "lat":52.37,
                  "lon":4.89
               }
            },
            "returningvisitor":false,
            "channel":"Hippo Acceptance Project",
            "dayofweek":3,
            "tracking":true,
            "parameters":{}
         },
         "data":{},
         "experimentSelectedVariantList":null,
         "personaIdScores":[],
         "globalPersonaIdScores":[]
      }
   ]
}

 

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?