Get Output Status

GET/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/statsOutput Connectors

Try it

GET/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/stats

Authentication

JSON web token (JWT) or API key (http bearer)

Parameters

pipeline_name (path, required)

view_name (path, required)

connector_name (path, required)

Retrieve the status of an output connector.

Authentication

JSON web token (JWT) or API keyBearer token

Parameters

Path parameters

Name	Type	Required	Description
`pipeline_name`	string	Yes	Unique pipeline name
`view_name`	string	Yes	SQL view name
`connector_name`	string	Yes	Output connector name

Response

200Output connector status retrieved successfullyapplication/json

object
Output endpoint status information.
- configobjectrequired
  Schema definition for endpoint config that only includes the stream field.
- encode_errorsConnectorError[]
  Recent encoding errors on this endpoint.
- endpoint_namestringrequired
  Endpoint name.
- fatal_errorstring
  The first fatal error that occurred at the endpoint.
- healthobject
- metricsobjectrequired
  Performance metrics for an output endpoint.
- transport_errorsConnectorError[]
  Recent transport errors on this endpoint.

404Pipeline, view and/or output connector with that name does not existapplication/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.

500application/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.

503application/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.


curl -X GET 'https://api.example.com/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/stats' \
  -H 'Authorization: Bearer YOUR_TOKEN'


const response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/stats', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
 
const data = await response.json();
console.log(data);


interface ApiResponse {
  // shape your response here
}
 
const response: Response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/stats', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
 
const data = (await response.json()) as ApiResponse;
console.log(data);


import requests
 
url = "https://api.example.com/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/stats"
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}
 
response = requests.request("get", url, headers=headers)
print(response.json())


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	req, err := http.NewRequest("GET", "https://api.example.com/v0/pipelines/{pipeline_name}/views/{view_name}/connectors/{connector_name}/stats", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(string(out))
}