/data/v2/projects/{projectToken}/customers/attributes
Retrieve different customer attributes.
Customer attributes is cluster API method that can be used to perform multiple operations: to retrieve customer aggregations, expressions, IDs, predictions, properties, recommendations, or segmentations.
Customer attributes is a cluster API method that can be used to retrieve customer's aggregations, expressions, IDs, predictions, properties, recommendations, or segmentations.
It takes in an array of attribute objects. The attribute "type" will define what type of customer attribute you want to retrieve, e.g. a segmentation, or customer properties.
You will find the definitions for these different possible objects below.
Definition
Authorization
In this API call you must use the following type of authorization accesses:
Available access types | Permissions needed |
---|---|
Private access | Varies per method, see specific definitions below |
Read more about:
Path parameters
Parameter | Type | Description | Required |
---|---|---|---|
projectToken | string | The ID of your project. | Required |
Body parameters
Parameter | Type | Description | Required |
---|---|---|---|
customer_ids | object | One or more hard and/or soft customer IDs are required. The most common ones include: registered . | At least 1 required. |
attributes | Array of objects | Array of attribute objects that specify properties to be retrieved. See below for available attribute object types and JSON code examples. | Required |
Headers
Parameter | Type | Description | Required |
---|---|---|---|
authorization | string | Used for authentication. Read more in the Authentication section. | Required |
content-type | string | application/json | Required |
Additional payload example
{
"customer_ids": {
"cookie": "382d4221-3441-44b7-a676-3eb5f515157f"
},
"attributes": [
{
"type": "property",
"property": "first_name"
},
{
"type": "property",
"property": "last_name"
},
{
"type": "segmentation",
"id": "592ff585fb60094e02bfaf6a"
},
{
"type": "id",
"id": "registered"
}
]
}