Skip to content

/observe

Retrieve detailed observability metrics for a given pipeline instance.

🧭 Endpoint

GET /ferry/{id}/observe

📥 Path Parameters

ParameterTypeDescription
idstringA unique identifier for the ingestion job.

📊 Response Fields

Top-Level

FieldTypeDescription
pipeline_namestringName of the pipeline instance
start_timedatetimeTimestamp when the pipeline started
end_timedatetimeTimestamp when the pipeline ended
statusstringStatus of the pipeline run
errorstringErrors if any in pipeline run
metricsobjectDetailed observability per phase

metrics.extract

FieldTypeDescription
start_timedatetimeWhen extract phase started
end_timedatetimeWhen extract phase ended
statusstringStatus of the extract phase
errorobject/nullErrors encountered during extraction
resource_metricsarrayList of extracted resource_metrics and metadata

metrics.normalize

FieldTypeDescription
start_timedatetimeWhen normalize phase started
end_timedatetimeWhen normalize phase ended
statusstringStatus of the normalize phase
errorobject/nullErrors encountered during extraction
resource_metricsarrayNormalized resources and file statistics

metrics.normalize

FieldTypeDescription
start_timedatetimeWhen normalize phase started
end_timedatetimeWhen normalize phase ended
statusstringStatus of the normalize phase
errorobject/nullErrors encountered during extraction

resource_metrics[]

FieldTypeDescription
namestringResource or table name
row_countintegerNumber of rows output
file_sizeintegerFile size in bytes

Released under the MIT License.