Export all customers

post

https://api.exponea.com/data/v2/projects/{projectToken}/customers/export

/data/v2/projects/{projectToken}/customers/export

Retrieve all customers, who exist in the project.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Authorization

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

Available access type	Permission needed
Private access	GDPR > Export customers

`attributes` object schema

Here is the schema of the request body parameter attributes:

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"
            }
        ]
    }

🚧
Important
When using event attributes id, property, and type, use attribute.list.id, attribute.list.property, and attribute.list.type in your request definition.

`filter` object schema

Here is the schema of the request body parameter filter:

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

📘
Note
For use cases that require date filtering, the Data Exports feature may be a better fit. Note that Data Exports is a paid feature and the API does not support date filtering.

Path Params

projectToken

string

required

Defaults to 12345678-1234-1234-1234-123456789abc

The ID of your project.

Body Params

format

string

required

The 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.

attributes

object

Attributes that should be exported. If not specified, all properties and identifiers are exported. Refer to the schema of the attributes object.

filter

object

Filter customers who should be exported. If not specified, all customers will be exported. Refer to the schema of the filter object.

execution_time

int32

The timestamp that should the customer filter and attributes be evaluated on. Default is current time.

timezone

string

Which timezone should the customer filter and attributes be evaluated on. Default is UTC. If you want to export results in a different time zone that is not UTC, specify a string in the time zone database in the following format ('Continent/City'). For example, 'Africa/Lagos'.

Headers

authorization

string

required

Defaults to Basic <KeyID/Secret>

Used for authentication. Read more in the Authentication section.

Response

Authorization

attributes object schema

Important

filter object schema

Note

200200

`attributes` object schema

`filter` object schema