Status - The Neighborhood

cURL

curl --request GET \
  --url https://app.indexing.co/dw/pipelines/{name}/status \
  --header 'X-API-KEY: <api-key>'

{
  "pipeline": "<string>",
  "enabled": true,
  "beatsDelivered": 123,
  "errors": 123
}

GET

/

pipelines

/

{name}

/

status

cURL

curl --request GET \
  --url https://app.indexing.co/dw/pipelines/{name}/status \
  --header 'X-API-KEY: <api-key>'

{
  "pipeline": "<string>",
  "enabled": true,
  "beatsDelivered": 123,
  "errors": 123
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

name

string

required

The name of the pipeline

Query Parameters

timeframe

enum<string>

default:24h

Time window for metrics. Defaults to 24h

Available options:

5m,

1h,

24h

Response

Pipeline health status

pipeline

string

The pipeline name

enabled

boolean

Whether the pipeline is enabled

timeframe

enum<string>

The time window used for metrics

Available options:

5m,

1h,

24h

beatsDelivered

integer

Number of beats successfully delivered within the timeframe

errors

integer

Number of errors logged within the timeframe