Set connector sync job stats APIedit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Sets connector sync job stats.


PUT _connector/_sync_job/<connector_sync_job_id>/_stats


  • To sync data using connectors, it’s essential to have the Elastic connectors service running.
  • The connector_sync_job_id parameter should reference an existing connector sync job.


Sets the stats for a connector sync job. Stats include: deleted_document_count, indexed_document_count, indexed_document_volume and total_document_count. last_seen can also be updated using this API. This API is mainly used by the connector service for updating sync job information.

Path parametersedit

(Required, string)

Request bodyedit

(Required, int) The number of documents the sync job deleted.
(Required, int) The number of documents the sync job indexed.
(Required, int) The total size of the data (in MiB) the sync job indexed.
(Optional, int) The total number of documents in the target index after the sync job finished.
(Optional, instant) The timestamp to set the connector sync job’s last_seen property.

Response codesedit

Indicates that the connector sync job stats were successfully updated.
No connector sync job matching connector_sync_job_id could be found.


The following example sets all mandatory and optional stats for the connector sync job my-connector-sync-job:

response = client.connector_sync_job.update_stats(
  connector_sync_job_id: 'my-connector-sync-job',
  body: {
    deleted_document_count: 10,
    indexed_document_count: 20,
    indexed_document_volume: 1000,
    total_document_count: 2000,
    last_seen: '2023-01-02T10:00:00Z'
puts response
PUT _connector/_sync_job/my-connector-sync-job/_stats
    "deleted_document_count": 10,
    "indexed_document_count": 20,
    "indexed_document_volume": 1000,
    "total_document_count": 2000,
    "last_seen": "2023-01-02T10:00:00Z"