Sign in
Audiences

Get an audience draft import batch

get/public/v1/audience-drafts/{audienceId}/import-batches/{batchId}

Path parameters

audienceIdstring cuid required
Example:example
batchIdstring cuid required
Example:example

Response

Audience import batch

idstring required
audienceIdstring required
status'PENDING' | 'PROCESSING' | 'CANCEL_REQUESTED' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required
versioninteger required
errorstring nullable
deletedPeopleCountinteger required
preservedPeopleCountinteger required
cancelRequestedAtstring date-time nullable
startedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "example",
  "audienceId": "example",
  "status": "PENDING",
  "version": 1,
  "error": "example",
  "imports": [
    {
      "id": "example",
      "audienceId": "example",
      "filename": "example",
      "disposition": "INCLUDE",
      "status": "PENDING",
      "totalRows": 1,
      "createdRows": 1,
      "linkedRows": 1,
      "completedRows": 1,
      "rejectedRows": 1,
      "error": "example",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "startedAt": "2024-01-01T12:00:00.000Z",
      "completedAt": "2024-01-01T12:00:00.000Z",
      "updatedAt": "2024-01-01T12:00:00.000Z"
    }
  ],
  "cancelRequestedAt": "2024-01-01T12:00:00.000Z",
  "startedAt": "2024-01-01T12:00:00.000Z",
  "completedAt": "2024-01-01T12:00:00.000Z",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "updatedAt": "2024-01-01T12:00:00.000Z"
}

Changes

Changed in 1 of the 2 revisions of this API.1