Get transform information | Elasticsearch API documentation

Path parameters

transform_idstring Required
A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

Query parameters

allow_no_matchboolean
Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.
fromnumber
Skips the specified number of transforms.
hstring | array[string]
Comma-separated list of column names to display.
Values are changes_last_detection_time, cldt, checkpoint, cp, checkpoint_duration_time_exp_avg, cdtea, checkpointTimeExpAvg, checkpoint_progress, c, checkpointProgress, create_time, ct, createTime, delete_time, dtime, description, d, dest_index, di, destIndex, documents_deleted, docd, documents_indexed, doci, docs_per_second, dps, documents_processed, docp, frequency, f, id, index_failure, if, index_time, itime, index_total, it, indexed_documents_exp_avg, idea, last_search_time, lst, lastSearchTime, max_page_search_size, mpsz, pages_processed, pp, pipeline, p, processed_documents_exp_avg, pdea, processing_time, pt, reason, r, search_failure, sf, search_time, stime, search_total, st, source_index, si, sourceIndex, state, s, transform_type, tt, trigger_count, tc, version, or v.
sstring | array[string]
Comma-separated list of column names or column aliases used to sort the response.
Values are changes_last_detection_time, cldt, checkpoint, cp, checkpoint_duration_time_exp_avg, cdtea, checkpointTimeExpAvg, checkpoint_progress, c, checkpointProgress, create_time, ct, createTime, delete_time, dtime, description, d, dest_index, di, destIndex, documents_deleted, docd, documents_indexed, doci, docs_per_second, dps, documents_processed, docp, frequency, f, id, index_failure, if, index_time, itime, index_total, it, indexed_documents_exp_avg, idea, last_search_time, lst, lastSearchTime, max_page_search_size, mpsz, pages_processed, pp, pipeline, p, processed_documents_exp_avg, pdea, processing_time, pt, reason, r, search_failure, sf, search_time, stime, search_total, st, source_index, si, sourceIndex, state, s, transform_type, tt, trigger_count, tc, version, or v.
timestring
The unit used to display time values.
Values are nanos, micros, ms, s, m, h, or d.
sizenumber
The maximum number of transforms to obtain.

Responses

200 application/json
Hide response attributes Show response attributes object
- idstring
- statestring
  The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check thereasonfield.indexing: The transform is actively processing data and creating new documents.started: The transform is running but not actively indexing data.stopped: The transform is stopped.stopping`: The transform is stopping.
- checkpointstring
  The sequence number for the checkpoint.
- documents_processedstring
  The number of documents that have been processed from the source index of the transform.
- checkpoint_progressstring | null
  The progress of the next checkpoint that is currently in progress.
  One of:
  string-1string string-2string | null
- last_search_timestring | null
  The timestamp of the last search in the source indices. This field is shown only if the transform is running.
  One of:
  string-1string string-2string | null
- changes_last_detection_timestring | null
  The timestamp when changes were last detected in the source indices.
  One of:
  string-1string string-2string | null
- create_timestring
  The time the transform was created.
- versionstring
- source_indexstring
  The source indices for the transform.
- dest_indexstring
  The destination index for the transform.
- pipelinestring
  The unique identifier for the ingest pipeline.
- descriptionstring
  The description of the transform.
- transform_typestring
  The type of transform: batch or continuous.
- frequencystring
  The interval between checks for changes in the source indices when the transform is running continuously.
- max_page_search_sizestring
  The initial page size that is used for the composite aggregation for each checkpoint.
- docs_per_secondstring
  The number of input documents per second.
- reasonstring
  If a transform has a failed state, these details describe the reason for failure.
- search_totalstring
  The total number of search operations on the source index for the transform.
- search_failurestring
  The total number of search failures.
- search_timestring
  The total amount of search time, in milliseconds.
- index_totalstring
  The total number of index operations done by the transform.
- index_failurestring
  The total number of indexing failures.
- index_timestring
  The total time spent indexing documents, in milliseconds.
- documents_indexedstring
  The number of documents that have been indexed into the destination index for the transform.
- delete_timestring
  The total time spent deleting documents, in milliseconds.
- documents_deletedstring
  The number of documents deleted from the destination index due to the retention policy for the transform.
- trigger_countstring
  The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.
- pages_processedstring
  The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
- processing_timestring
  The total time spent processing results, in milliseconds.
- checkpoint_duration_time_exp_avgstring
  The exponential moving average of the duration of the checkpoint, in milliseconds.
- indexed_documents_exp_avgstring
  The exponential moving average of the number of new documents that have been indexed.
- processed_documents_exp_avgstring
  The exponential moving average of the number of documents that have been processed.

GET /_cat/transforms/{transform_id}

GET /_cat/transforms?v=true&format=json

resp = client.cat.transforms(
    v=True,
    format="json",
)

const response = await client.cat.transforms({
  v: "true",
  format: "json",
});

response = client.cat.transforms(
  v: "true",
  format: "json"
)

$resp = $client->cat()->transforms([
    "v" => "true",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/transforms?v=true&format=json"

Response examples (200)

A successful response from `GET /_cat/transforms?v=true&format=json`.

[
  {
    "id" : "ecommerce_transform",
    "state" : "started",
    "checkpoint" : "1",
    "documents_processed" : "705",
    "checkpoint_progress" : "100.00",
    "changes_last_detection_time" : null
  }
]

Path parameters

Query parameters

Responses

checkpoint_progressstring | null

last_search_timestring | null

changes_last_detection_timestring | null