IncrementingCountCursor

Cursor that allows for incremental sync according to a continuously increasing integer.

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

type

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

cursor_field

The location of the value on a record that will be used as a bookmark during sync. To ensure no data loss, the API must return records in ascending order based on the cursor field. Nested fields are not supported, so the field must be at the top level of the record. You can use a combination of Add Field and Remove Field transformations to move the nested field to the top.

• Required: Yes
• type: string
• Available variables: config

Examples:

created_at

{{ config['record_cursor'] }}

allow_catalog_defined_cursor_field

Whether the cursor allows users to override the default cursor_field when configuring their connection. The user defined cursor field will be specified from within the configured catalog.

• Required: No
• type: boolean

start_value

The value that determines the earliest record that should be synced.

• Required: No
• Available variables: config

Examples:

0

{{ config['start_value'] }}

• anyOf:

  • type: string

• anyOf:

  • type: integer

start_value_option

Optionally configures how the start value will be sent in requests to the source API.

• Required: No
• Allowed type: RequestOption

$parameters

• Required: No
• type: object