Skip to main content

RequestWindowSplitting

Describes how the request window is split when an error handler resolves to the SPLIT_REQUEST_WINDOW action. The connector replaces the failing window with two smaller, ordered windows covering the same range and reads each one fully before checkpointing. If the failing window had already emitted records, those may be re-emitted; downstream primary-key deduplication is expected to handle that. Only supported on a stream whose incremental_sync cursor defines cursor_granularity. Distinct from page_size_reduction, which shrinks a paginator's page size rather than the cursor's window.

  • type: object
  • required: ["type"]

type​

  • Required: Yes
  • type: string
  • enum: ["RequestWindowSplitting"]

failure_message​

Sentence appended to the error message when the connector can no longer split the window further. Use it to tell the user what to do for this API, for instance which filter narrows the query down.

  • Required: No
  • type: string

Examples:

Narrow the sync down by selecting fewer fields on this stream.
Lower time_window so that each request covers less data.

min_split_window​

Approximate smallest window (ISO 8601 duration) the connector will split down to - a window at or below this size is not split further, though the result can end up a bit smaller than this, not larger. Independent of, and usually looser than, cursor_granularity - useful when a cursor could split further but many small requests are worse for this API than a few large ones.

  • Required: No
  • type: string

Examples:

P1D
PT1H
Was this page helpful?