Set the connector sync job stats Technical preview
Stats include: deleted_document_count
, indexed_document_count
, indexed_document_volume
, and total_document_count
.
You can also update last_seen
.
This API is mainly used by the connector service for updating sync job information.
To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
Path parameters
-
The unique identifier of the connector sync job.
Body Required
-
The number of documents the sync job deleted.
-
The number of documents the sync job indexed.
-
The total size of the data (in MiB) the sync job indexed.
-
last_seen string
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
metadata object
-
total_document_count number
The total number of documents in the target index after the sync job finished.
curl \
-X PUT http://api.example.com/_connector/_sync_job/{connector_sync_job_id}/_stats \
-H "Content-Type: application/json" \
-d '{"deleted_document_count":42.0,"indexed_document_count":42.0,"indexed_document_volume":42.0,"last_seen":"string","metadata":{"additionalProperty1":{},"additionalProperty2":{}},"total_document_count":42.0}'
{
"deleted_document_count": 42.0,
"indexed_document_count": 42.0,
"indexed_document_volume": 42.0,
"last_seen": "string",
"metadata": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"total_document_count": 42.0
}
{}