Read GDPR Request Log

GET /users/gdpr-log
Copied
Arrow
                https://api.ocamba.com/v1/hood/users/gdpr-log

Retrieves the details of a User if a valid identifier was provided

query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ gdpr-data ]
An array of all created items.
GDPR log data
Name
Description
client_idstring
A unique client identifier generated by the Ocamba.


Example: 17383247367618690119
company_idstring
A unique company identifier generated by the Ocamba.


Example: 7196310
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
failure_reasonstring
Only applicable for failed requests. Describes the reason why the request failed.


Example: decryption failed
fieldsarray
The array of fields of the client structure that are accessed through the request.


Example: ["mobile_phone_number","email"]
idstring
A unique identifier generated by the Ocamba.


Example: 450
member_idstring
A unique member identifier generated by the Ocamba.


Example: 2212990
requeststring
The request through which the PI data is accessed.


Example: /v1/hood/users?first_session_date=2025-01-31&decrypt=true
statusstring
The status of the request, if someone successfully accessed the PI data, the status will display 'success'.


Example: failed

Possible values: success | failed
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "id": "15",
  "company_id": "6197120",
  "member_id": "1000165",
  "client_id": "17385704483184259699",
  "fields": [
    "mobile_phone_number",
    "email"
  ],
  "status": "success",
  "create_time": "2025-02-04 10:07:11",
  "update_time": "2025-02-04 10:07:11"
}

{
  "total": 1,
  "items": [
    {
      "id": "450",
      "company_id": "7196310",
      "member_id": "2212990",
      "client_id": "17383247367618690119",
      "fields": "[\"mobile_phone_number\",\"email\"]",
      "status": "failed",
      "request": "/v1/hood/users?first_session_date=2025-01-31&decrypt=true",
      "failure_reason": "decryption failed",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}