Skip to main content

Create IP Batch Export

POST 
/ip/batch/:jobId/exports

The Create IP 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., result.riskReport.score)

Example Request:​

{
  "exportType": "json",
  "filters": {
    "result.riskReport.level": "low,medium",
    "result.riskReport.score": { "max": 500 },
    "result.geo.countryCode": ["US", "CA", "GB"]
  }
}

Request​

Responses​

Export request accepted for processing.