View Customer Data

GET /customer-data/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/customer-data/{id}

Retrieves the details of a Customer Data Object that has previously been created if a valid identifier is provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
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
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ customer-data ]
An array of all created items.
Customer List
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 7196310
create_timestring
Timezone: GMT.


Example: 2025-01-29 12:47:00
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000105
pi_datanumber (integer)
Describes if the target will be PI sensitive. If so, the data that will be added to the key, when adding it as extra to users, will be encrypted.


Example: 1

Possible values: 0 | 1
targetstring
A data key that will be used to add data to users as extra.


Example: data_key
update_timestring
Timezone: GMT.


Example: 2025-01-30 14:27:26
totalinteger
A total number of items.


Example: 1
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
tip
1 If you don't know the customer data id, list the customer data to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
  • 500
{
    "total": 1,
    "items": [
      {
        "id": "343774",
        "company_id": "6197120",
        "target": "test-data",
        "pi_data": 1
        "create_time": "2025-02-06 11:15:10",
        "update_time": "2025-02-06 11:15:10"
      }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "1000105",
      "company_id": "7196310",
      "target": "data_key",
      "pi_data": 1,
      "create_time": "2025-01-29 12:47:00",
      "update_time": "2025-01-30 14:27:26"
    }
  ]
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}