GuidesRecipesAPI Reference
API Reference
Select productLog inHelp centre

Exports the result of a profile query in a formatted file for download

post
https://{region}-api.dotdigital.com/cpaas/profiles/export

For format=csv, due to the flat file format, only primitive types will be exported. Non-primitive type will be exported with "--INVALID-TYPE--" as the data. Nested data should be referred to explicitly: "address.line1"

Query Params
string

See https://www.npmjs.com/package/mongo-querystring for export query syntax.

Body Params

Export options

string
enum
required

The format to export profile data in

Allowed:
fields
array of strings

The list of fields to export, in order (only used for csv exports)

fields
string

The character to delimit each field (only used for csv exports)

boolean

Whether to include the field names as a header (only used for csv exports)

Response
200

Data exported in the required format

Updated 6 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here!
Updated 6 months ago