Start Export Job

📘

Note

There are two IDs returned in the response. The export ID is the first id value in the response body (above the path value). This is the ID you should use for the Get Export Job Status API.

You can either request an unfiltered or filtered export:

• Unfiltered – You must include the objects array in your request body. For example:
  JSON

  {
    "format": "csv",
    "delimiter": "comma",
    "objects": [
      "products"
    ]
  }

• Filtered – You must include the select object in your request body. For example:
  JSON

  {
    "format": "csv",
    "delimiter": "comma",
    "select": {
      "object": "events",
      "fields": [
        "product.name"
      ],
      "filter": {
        "field": "product.name",
        "operator": "=",
        "value": "%shoe%"
      },
      "sorts": [
        {
          "field": "product.name",
          "order": "asc"
        }
      ]
    }
  }