Serve Personal Data

Prerequisites

Before you begin, ensure that the Public Relevance REST API is enabled in your project. This documentation assumes the API is available under the /gdpr path, but you can configure the endpoint path as needed. Refer to the Public Relevance REST API documentation for details on endpoint configuration.

Serving Personal Data

When the Public Relevance REST API is enabled, visitors can retrieve their personal data by sending a GET request to:

/gdpr/visitorinfo

Note: The /gdpr segment in the path depends on your API configuration.

To comply with GDPR requirements, provide a button or link on your website that allows visitors to access this endpoint and view the personal data stored about them.

The API returns a JSON response containing the visitor's data. The structure and content of the response depend on the specific data collected in your implementation. If you require a different format or representation, you can implement a custom REST endpoint. For more information, see the Public Relevance REST API documentation.

By default, the API returns a maximum of 200 recent request entries per visitor. This limit prevents excessive server load and bandwidth usage. To change this behavior, implement a custom REST endpoint.

If a visitor has requested data erasure (see Forget About Me), subsequent requests to /gdpr/visitorinfo will return the following response:

{
  "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":[]
      }
   ]
}