Get Output Status

Required role: read or higher.

Retrieve the status of an output connector.

Path Parameters
pipeline_name string — REQUIRED Unique pipeline name
view_name string — REQUIRED SQL view name
connector_name string — REQUIRED Output connector name

Responses
200 Output connector status retrieved successfully Schema — OPTIONAL config object Schema definition for endpoint config that only includes the stream field. stream string The name of the stream. encode_errors object[] — OPTIONAL Recent encoding errors on this endpoint. index int64 Sequence number of the error. The client can use this field to detect gaps in the error list reported by the pipeline. When the connector reports a large number of errors, the pipeline will only preserve and report the most recent errors of each kind. message string Error message. tag string — OPTIONAL Optional tag for the error. The tag is used to group errors by their type. timestamp date-time Timestamp when the error occurred, serialized as RFC3339 with microseconds. endpoint_name string Endpoint name. fatal_error string — OPTIONAL The first fatal error that occurred at the endpoint. health object — OPTIONAL description string — OPTIONAL status string Possible values: [Healthy, Unhealthy] metrics object Performance metrics for an output endpoint. batch_records_written int64 — OPTIONAL Number of records written so far while the connector is processing a batch of updates. Resets to 0 after the batch is committed. None when the connector does not support batch-progress reporting. buffered_batches int64 Number of batches in the buffer. buffered_records int64 Number of records pushed to the output buffer. memory int64 Extra memory in use beyond that used for queuing records. num_encode_errors int64 Number of encoding errors. num_transport_errors int64 Number of transport errors. queued_batches int64 Number of queued batches. queued_records int64 Number of queued records. total_processed_input_records int64 The number of input records processed by the circuit. This metric tracks the end-to-end progress of the pipeline: the output of this endpoint is equal to the output of the circuit after processing total_processed_input_records records. The counter never runs ahead of the endpoint's output. It advances to a value N only once the endpoint has processed every batch derived from the first N records received by the pipeline, which means transmitting the batch, or discarding it while silent bootstrapping suppresses the endpoint's output. In a multihost pipeline, N counts the input records that all of the hosts received, not only the endpoint's own host. (Each host counts only its own input, and the coordinator adds up the hosts' counts as of total_processed_steps.) If a host runs an older version that does not report its count to the coordinator, N counts only the input records that the endpoint's own host received. total_processed_steps int64 The number of steps whose input records have been processed by the endpoint. In a multihost pipeline, all of the hosts run the same steps together, so a step number refers to the same step on every host. Interpretation This is a count, not a step number. If total_processed_steps is 0, no steps have been processed to completion. If total_processed_steps > 0, then the last step whose input records have been processed to completion is total_processed_steps - 1. A record that was ingested in step n is fully processed when total_processed_steps > n. transmitted_bytes int64 Bytes sent on the underlying transport. transmitted_records int64 Records sent on the underlying transport. paused boolean — OPTIONAL Endpoint has been paused by the user. A paused output endpoint discards the output it receives instead of sending it to its sink. transport_errors object[] — OPTIONAL Recent transport errors on this endpoint. index int64 Sequence number of the error. The client can use this field to detect gaps in the error list reported by the pipeline. When the connector reports a large number of errors, the pipeline will only preserve and report the most recent errors of each kind. message string Error message. tag string — OPTIONAL Optional tag for the error. The tag is used to group errors by their type. timestamp date-time Timestamp when the error occurred, serialized as RFC3339 with microseconds.
404 Pipeline, view and/or output connector with that name does not exist Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.
500 Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.
503 Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.