Definition

Authorization

In this API call you must use the following authorization access and permissions:

Available access type	Permission needed
Private access	GDPR > Export customers

Path parameters

Parameter	Type	Description	Required
projectToken	string	The ID of your project.	Required

Body parameters

Parameter	Type	Description	Required
attributes	object	Attributes that should be exported. If not specified, all properties and identifiers are exported.	No
filter	object	Filter customers who should be exported. If not specified, all customers will be exported.	No
execution_time	int32	The timestamp that should the customer filter and attributes be evaluated on. Default is `current time`.	No
timezone	string	Which timezone should the customer filter and attributes be evaluated on. Default is `UTC`.	No
format	string	Output format. `csv` - CSV table with header explaining which column corresponds to which attribute, in case of some attributes, the order is the same as specified in the list array. In other cases the first are ids, then properties and last the rest of attributes `table_json` - Similar to CSV format, but with data represented in JSON.	Required

Attributes object parameters

Parameter	Type	Description	Required
type	string	`some` = only specified attributes in the request `properties_and_ids` = all properties and identifiers (default)	No
list	array of objects	Define attributes, that you want to export. Only available when `type: some` is used.	Required if `some` is used as `attributes.type`.

Additional example of the attributes

"attributes": {
        "type": "some",
        "list": [
            {
                "type": "id",
                "id": "registered"
            },
            {
                "type": "id",
                "id": "cookie"
            }
        ]
    }

Filter object parameters

Parameter	Type	Description
type	string	`segment` = customers from a segment `all` = all customers (default)
segmentation_id	string	ID of segmentation that should be applied for filtering customers.
segment_index	int32	Index of segment from the segmentation. Only customers from this segment will be exported. Indexed from 0. Customers that don't match any of the segments belongs to segment_index -1.

🚧
Attributes - id, property, type
When operating with event attributes id, property and type, correct request definition needs to use attribute.list.id, attribute.list.property and attribute.list.type

Headers

Parameter	Type	Description	Required
authorization	string	Used for authentication. Read more in the Authentication section.	Required
content-type	string	application/json	Required

📘
For some use cases, it's better to use the Data Exports Bloomreach Engagement feature, since the API does not support date filtering (note that Exports are a paid feature).

Export all customers

Definition

Authorization

Path parameters

Body parameters

Attributes object parameters

Filter object parameters

🚧
Attributes - id, property, type

Headers

📘

Definition

Authorization

Path parameters

Body parameters

Attributes object parameters

Filter object parameters

🚧Attributes - id, property, type

Headers

📘

🚧
Attributes - id, property, type