Releasesv0.1.0
Api referenceEndpointsPipeline

The tenant's pipeline, stage by stage

GET
/v1/pipeline

Counts of the tenant's work at each stage, in the order data flows: the sources (providers that are on, and any provider still holding the tenant's connections), the sync runs, the processing jobs, the raw archive and the webhook deliveries. Counts only, never a health value. The console's overview is this answer.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The pipeline.

application/json
  1. response
generated_at*string
Formatdate-time
users*
sources*array<>
sync*

Sync runs in flight (queued, running, retrying after a failed attempt, rate_limited), and those created in the last 24 hours that ended failed or succeeded.

processing*

Processing jobs by status, and the records processing rejected and has not recovered (as in the coverage report).

storage*

Raw payloads stored in the last 24 hours.

delivery*

Webhook endpoints (failing ones are on but their last deliveries failed) and the deliveries not done.

curl -X GET 'http://localhost:8080/v1/pipeline' \  -H 'Authorization: Bearer ohs_sk_...'
{  "generated_at": "2019-08-24T14:15:22Z",  "users": {    "active": 0,    "deleting": 0  },  "sources": [    {      "slug": "string",      "name": "string",      "kinds": [        "oauth"      ],      "enabled": true,      "connections": {        "property1": 0,        "property2": 0      },      "broken": 0,      "paused_until": "2019-08-24T14:15:22Z"    }  ],  "sync": {    "queued": 0,    "running": 0,    "retrying": 0,    "rate_limited": 0,    "failed_24h": 0,    "succeeded_24h": 0  },  "processing": {    "pending": 0,    "running": 0,    "parked": 0,    "rejected_records": 0  },  "storage": {    "raw_objects_24h": 0,    "raw_bytes_24h": 0  },  "delivery": {    "endpoints": 0,    "endpoints_failing": 0,    "endpoints_disabled": 0,    "pending": 0,    "parked": 0  }}
Edit on GitHub