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

Rate limits:

Burst: 10/s
Steady: 150/m

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 Property
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
data_typestring
This defines the expected format of the property value, such as text, number or data(currently only 'text' is supported). The data type helps ensure that the property values are validated and processed correctly when used in the system.


Example: text

Possible values: text | number | date

Default: text
descriptionstring
The more detailed description of the Customer Property. string[0 .. 2000]


Example: Custom region information associated with the customer. Can be used to group or filter customers based on regional segmentation defined by your organization.
examplestring
An example value that illustrates the typical format or content expected for this property. It helps users understand how to populate the field correctly during data entry or import.


Example: northern_europe
export_aliasstring
Optional alias to use for this property during data export. If not set, the original property name will be used.. string[1 .. 255]


Example: region_name
exportablenumber (integer)
Indicates whether the property should be included when exporting Customers. If set to 1, this property will be part of export operations.


Example: 1

Possible values: 0 | 1
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000105
import_aliases[ string ]
Alternative names that can be used to identify this property during data import. Useful when importing data from external systems with varying field names. array[1 .. 10]
importablenumber (integer)
Indicates whether the property can be populated through Customer import. If set to 1, this property will be recognized and processed during import operations.


Example: 1

Possible values: 0 | 1
labelstring
A human-readable name for the property. It will be automatically sanitized by converting all characters to lowercase and replacing spaces with underscores. Must be unique per customer property and cannot be empty. string[0 .. 255]


Example: my_region
pi_datanumber (integer)
Indicates whether the property contains Personally Identifiable Information (PII). If set to 1, values will be encrypted and access will be restricted to users with appropriate permissions.


Example: 1

Possible values: 0 | 1
systemnumber (integer)
Indicates whether the property is part of the Ocamba's predefined customer set of properties. A value of 0 means the property is custom and user-defined, while a value of 1 means the property is part of the Ocamba's default set of customer properties.


Example: 1

Possible values: 0 | 1
targetstring
Legacy field provided for backward compatibility. It is included in responses but no longer accepted in requests. Use the 'label' field for defining custom property identifiers going forward.


Example: my_region
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
titlestring
The error title.


Example: Internal server error.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
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": "my_region",
      "label": "my_region",
      "data_type": "text",
      "example": "northern_europe",
      "description": "Custom region information associated with the customer. Can be used to group or filter customers based on regional segmentation defined by your organization.",
      "import_aliases": [
        "region_name"
      ],
      "export_alias": "region_name",
      "pi_data": 1,
      "system": 1,
      "importable": 1,
      "exportable": 1,
      "create_time": "2025-01-29 12:47:00",
      "update_time": "2025-01-30 14:27:26"
    }
  ]
}

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}