Get Health

GET

/api/v1/health

const url = 'https://4dqyvfjdrf.execute-api.us-east-2.amazonaws.com/api/v1/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://4dqyvfjdrf.execute-api.us-east-2.amazonaws.com/api/v1/health

Responses

200

Successful Response

application/json

HealthResponse

object

sources

required

Sources

Array<object>

SourceHealthRecord

object

source

required

Source

string

last_error

Any of:

string
null

string

post_count

Post Count

integer

display_name

required

Display Name

string

last_crawl_at

Any of:

string
null

string format: date-time

source_status

SourceStatus

string

default: ok

Allowed values: ok stale error

consecutive_failures

Consecutive Failures

integer

last_successful_crawl_at

Any of:

string
null

string format: date-time

db_status

required

Db Status

string

last_crawl

Any of:

string
null

string format: date-time

Example

{
  "sources": [
    {
      "post_count": 0,
      "source_status": "ok",
      "consecutive_failures": 0
    }
  ]
}