v1

latestOpenAPI 3.0.22026-07-26480119.6 KB
Health

Health Check

This endpoint performs a diagnostic check on the API service to ensure it is running correctly. It returns a simple status message indicating if the system is operational and ready to receive requests, useful for monitoring and heartbeat checks.

get/api/company_analytic/v1/health

Headers

x-api-keystring required

Company Group API Key

Response

returns http status :ok

statusstring

Example response

{
  "status": "ok"
}