Use this API to export profile data from WMI.

  • View a list of previously requested exports
  • View details of a previously requested export
  • Request a new export

For full details on using the Export API, refer to the WMI Export API in API Explorer

API Endpoints

These are the endpoints available with the Export API.

Endpoint Method Description
/export GET Gets a history of exports jobs. Use method to get the export id.
/export/{id} GET Gets the details about a specific export.
/export POST Triggers a job to export data from a profile table

Export Parameters

Parameter Required? Description
fields Yes A list of fields that are exported. Fields are exported in the order they occur in the list.
filename Yes Path to the output file in Object Storage.
key Yes The encryption key used to encrypt the exported file.
profile Yes Name of the source profile used for the export.
charset No Defines the encoding of the exported file.
dateFormat No The string format used for date fields.
delimiter No A character to separate column values in the exported output.
filters No A list of filter conditions used for the export.
header No Indicates if the exported file contains a header row.
quote No Enclose text fields in double quotation marks. Delimiters occurring inside quotes are ignored.

API Endpoint Examples

Endpoint Action Example
/export GET
curl -X GET --header 'Accept: application/json' --header 'Authorization: APIKey yourapikeyvalue' 'https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/export'
/export/{id} GET
curl -X GET --header 'Accept: application/json' --header 'Authorization: APIKey yourapikeyvalue' 'https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/export/b99d51e4-ee29-4e54-8c74-8327f3561c3'
/export/{p1:v1,p2:[v2a],[v2b],[..],..} POST
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: APIKey yourapikeyvalue' -d '{
  "file": "profile_data.csv",
  "header": false,
  "overwrite": false,
  "fields": [
    "string"
  ],
  "filters": [
    "string"
  ]
}' 'https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/export'

Join The Discussion

Your email address will not be published. Required fields are marked *