GET
/
health
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

async function main() {
  const health = await client.health.get();

  console.log(health.data);
}

main();
{
  "data": {
    "status": "healthy",
    "version": "1.0.0",
    "timestamp": "2025-03-29T11:13:51.028Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
Health check response
​
data
object
required

Health check response payload

Example:
{
  "status": "healthy",
  "version": "1.0.0",
  "timestamp": "2025-03-29T11:13:51.028Z"
}