Skip to main content

Create Email Batch Export

POST 
/email/batch/:jobId/exports

The Create Email Batch Export endpoint allows you to request a custom export of completed batch analysis results. You can apply filters, select specific columns, and choose the output format (CSV or JSON).

Features:​

  • Format Options: Export results as CSV or JSON
  • Filtering: Apply filters on any field in the response data
  • Column Selection: Choose specific fields to include in the export
  • Async Processing: Export requests are processed asynchronously

Filter Syntax:​

  • String filters: Exact match, comma-separated values, or arrays
  • Numeric filters: Exact values, arrays, or range objects with min/max
  • Nested fields: Use dot notation (e.g., riskReport.score)

Example Request:​

{
  "exportType": "csv",
  "filters": {
    "isDeliverable": "yes",
    "riskReport.score": { "min": 0, "max": 400 },
    "emailProvider": ["gmail", "yahoo", "outlook"]
  },
  "columns": [
    "emailAddress",
    "emailProvider",
    "riskReport.score",
    "isDeliverable"
  ]
}

Request​

Responses​

Export request accepted for processing.