Query parameters

• from number

  Starting offset

• size number

  Specifies a max number of results to get

• status string

  A sync job status to fetch connector sync jobs for

  Values are canceling, canceled, completed, error, in_progress, pending, or suspended.

• connector_id string

  A connector id to fetch connector sync jobs for

• job_type string | array[string]

  A comma-separated list of job types to fetch the sync jobs for

  Values are full, incremental, or access_control.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • count number Required
  • results array[object] Required
    Hide results attributes Show results attributes object

    • cancelation_requested_at string | number

      One of:

      string-1 string EpochTimeUnitMillis number

      Time unit for milliseconds

    • canceled_at string | number

      One of:

      string-1 string EpochTimeUnitMillis number

      Time unit for milliseconds

    • completed_at string | number

      One of:

      string-1 string EpochTimeUnitMillis number

      Time unit for milliseconds

    • connector object Required
      Hide connector attributes Show connector attributes object

      • configuration object Required
      • filtering object Required
      • id string Required
      • index_name string Required
      • language string
      • pipeline object
      • service_type string Required
      • sync_cursor object

    • created_at string | number

      One of:

      string-1 string EpochTimeUnitMillis number

      Time unit for milliseconds

    • deleted_document_count number Required
    • error string
    • id string Required
    • indexed_document_count number Required
    • indexed_document_volume number Required
    • job_type string Required

      Values are full, incremental, or access_control.

    • last_seen string | number

      One of:

      string-1 string EpochTimeUnitMillis number

      Time unit for milliseconds

    • metadata object Required
      Hide metadata attribute Show metadata attribute object

      • * object Additional properties

    • started_at string | number

      One of:

      string-1 string EpochTimeUnitMillis number

      Time unit for milliseconds

    • status string Required

      Values are canceling, canceled, completed, error, in_progress, pending, or suspended.

    • total_document_count number Required
    • trigger_method string Required

      Values are on_demand or scheduled.

    • worker_hostname string