How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Feldera Metrics & Debugging API

The Metrics & Debugging API from Feldera — 15 operation(s) for metrics & debugging.

Feldera Metrics & Debugging API is one of 6 APIs that Feldera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metrics & Debugging. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 15 paths, and defines 38 schemas. It is described by OpenAPI 3.0.3, at version 0.323.0.

Requests are made against the base URL https://try.feldera.com.

16 operations 15 paths 38 schemas 14 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.323.0
Base URL
https://try.feldera.com
Authentication
HTTP Bearer
License
MIT OR Apache-2.0
Resource Areas
1

Authentication & Security 1

Feldera Metrics & Debugging API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (JSON web token (JWT) or API key).

  • JSON web token (JWT) or API key — Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the /v0/api-keys endpoint.

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 14 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Metrics & Debugging 16
GET
/v0/metrics
List All Metrics
get_metrics → 200
GET
/v0/pipelines/{pipeline_name}/circuit_json_profile
Performance Profile JSON
get_pipeline_circuit_json_profile 1 param → 200404500503
GET
/v0/pipelines/{pipeline_name}/circuit_profile
Get Performance Profile
get_pipeline_circuit_profile 1 param → 200404500503
POST
/v0/pipelines/{pipeline_name}/clock/advance
Advance Clock
clock_advance 1 param body → 200400503
GET
/v0/pipelines/{pipeline_name}/dataflow_graph
Get Dataflow Graph
get_pipeline_dataflow_graph 1 param → 200404500
GET
/v0/pipelines/{pipeline_name}/events
List Pipeline Events
list_pipeline_events 2 params → 200404500
GET
/v0/pipelines/{pipeline_name}/events/{event_id}
Get Pipeline Event
get_pipeline_event 3 params → 200400404500
GET
/v0/pipelines/{pipeline_name}/heap_profile
Get Heap Profile
get_pipeline_heap_profile 1 param → 200400404500503
GET
/v0/pipelines/{pipeline_name}/logs
Stream Pipeline Logs
get_pipeline_logs 1 param → 200404500503
GET
/v0/pipelines/{pipeline_name}/metrics
Get Pipeline Metrics
get_pipeline_metrics 2 params → 200404500503
GET
/v0/pipelines/{pipeline_name}/samply_profile
Get Samply Profile
get_pipeline_samply_profile 3 params → 200400404500503
POST
/v0/pipelines/{pipeline_name}/samply_profile
Start a Samply profile
start_samply_profile 3 params → 202404409500503
GET
/v0/pipelines/{pipeline_name}/stats
Get Pipeline Stats
get_pipeline_stats 1 param → 200404500503
GET
/v0/pipelines/{pipeline_name}/support_bundle
Download Support Bundle
get_pipeline_support_bundle 12 params → 200400404500503
GET
/v0/pipelines/{pipeline_name}/time_series
Get Time Series Stats
get_pipeline_time_series 1 param → 200404500503
GET
/v0/pipelines/{pipeline_name}/time_series_stream
Stream Time Series
get_pipeline_time_series_stream 1 param → 200404500503

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are GlobalControllerMetrics (32 properties), PipelineMonitorEventSelectedInfo (13 properties), OutputEndpointMetrics (12 properties), InputEndpointStatus (10 properties). Each schema is shown below with its type and property counts.

StorageStatus
string
Storage status. The storage status can only transition when the resources status is Stopped. text Cleared ───┐ ▲ │ /clear │ │ │ │ Clearing │ ▲ │ │ │ InUse ◄───┘
SampleStatistics
object
One sample of time-series data.
4 properties 4 required
InputEndpointStatus
object
Input endpoint status information.
10 properties 5 required
SuspendError
Whether a pipeline supports checkpointing and suspend-and-resume.
TransactionStatus
string
Transaction status summarized as a single value.
TimeSeries
object
Time series to make graphs in the web console easier.
2 properties 2 required
CommitProgressSummary
object
Summary of transaction commit progress.
5 properties 5 required
ConnectorHealth
object
2 properties 1 required
ProgramStatus
string
Program compilation status.
TransactionPhase
string
Transaction phase.
PipelineMonitorEventSelectedInfo
object
Pipeline monitor event information which has a selected subset of optional fields. If an optional field is not selected (i.e., is None), it will not be seriali…
13 properties 7 required
ResourcesStatus
string
Pipeline resources status. text /start (early start or provision check failed) ┌───┐ │ ▼ Stopped ◄────────── Stopping /start │ ▲ │ │ /stop?force=true │ │ OR: t…
PermanentSuspendError
Reasons why a pipeline does not support suspend and resume operations.
ErrorResponse
object
Information returned by REST API endpoints on error.
3 properties 3 required
MemoryPressure
string
Memory pressure level. The current memory pressure level is computed as a function of the current process resident set size (RSS) and the user-configured memor…
OutputEndpointStatus
object
Output endpoint status information.
7 properties 3 required
ClockAdvanceResponse
object
Response of POST /clock/advance: the new NOW() value as both milliseconds since epoch (signed; pre-1970 anchors yield negative values) and an RFC 3339 string.
2 properties 2 required
InputEndpointMetrics
object
Performance metrics for an input endpoint.
7 properties 7 required
ConnectorError
object
4 properties 3 required
ConcurrentBootstrapPhase
string
Phase of a concurrent bootstrap. [repr(u8)] + NoUninit so it can be stored in a lock-free Atomic.
ConnectorTransactionPhase
object
Connector transaction phase with debugging label.
2 properties 1 required
GlobalControllerMetrics
object
Global controller metrics.
32 properties 28 required
ClockAdvanceRequest
object
Body of POST /clock/advance. deltams is unsigned; negative values fail JSON deserialization. Some(0) reads the current NOW() without moving it or rounding it;…
1 property
ResourcesDesiredStatus
string
PipelineMonitorEventId
string
Pipeline monitor event identifier.
RuntimeStatus
string
Runtime status of the pipeline. Of the statuses, only Unavailable is determined by the runner. All other statuses are determined by the pipeline and taken over…
PipelineState
string
Pipeline state.
ShortEndpointConfig
object
Schema definition for endpoint config that only includes the stream field.
1 property 1 required
ControllerStatus
object
Complete pipeline statistics returned by the /stats endpoint. This schema definition matches the serialized JSON structure from adapters::controller::Controlle…
6 properties 3 required
RuntimeDesiredStatus
string
TransactionInitiators
object
Information about entities that initiated the current transaction.
3 properties 1 required
CompletedWatermark
object
A watermark that has been fully processed by the pipeline.
4 properties 4 required
OutputEndpointMetrics
object
Performance metrics for an output endpoint.
12 properties 11 required
TemporarySuspendError
Reasons why a pipeline cannot be suspended at this time.
ConnectorHealthStatus
string
PipelineMonitorEventFieldSelector
string
MetricsFormat
string
Circuit metrics output format. - prometheus: [format](https://github.com/prometheus/docs/blob/4b1b80f5f660a2f8dc25a54f52a65a502f31879a/docs/instrumenting/expos…
CheckpointActivity
Current checkpoint activity state.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

feldera-metrics-debugging-api-openapi.yml Raw ↑

Other APIs Feldera publishes across the network.

Feldera Input Connectors API
Feldera Output Connectors API
Feldera Pipeline CRUD API
Feldera Pipeline Lifecycle API
Feldera Platform API
Where this information came from

This is an independent, third-party profile of Feldera Metrics & Debugging API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.