API REFERENCE · SCHEMA

BatchPage schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

itemsRequired
Batch[]
items item fields

Each array item: Batch.

items[].idRequired
string

Format: uuid.

items[].nameRequired
string
items[].environmentRequired
string

Values: "sandbox", "production".

items[].statusRequired
string

Values: "importing", "pending", "processing", "completed", "cancelled", "failed".

items[].totalRequired
integer

Minimum: 0.

items[].completedRequired
integer

Minimum: 0.

items[].failedRequired
integer

Minimum: 0.

items[].created_atRequired
string

Format: date-time.

items[].cancelled_atRequired
string or null

May be null.

items[].cancelled_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

nextCursorRequired
string or null

May be null.

nextCursor fields and rules

Allowed alternatives

  • string
  • null

    May be null.

Use BatchPage in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides