healthcheck

Service Health Check
Check whether the public GuGuData API service is reachable and returning the standard v1 response envelope.

Method: GET
Path: /healthcheck
Demo: https://api.gugudata.io/healthcheck
OpenAPI: https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

Request Parameters:

No request parameters.

Response Fields:

dataStatus (object, required): Response metadata returned by the current v1 contract.

dataStatus.requestParameter (string, required): Normalized request parameters echoed by the service.

dataStatus.statusCode (integer, required): Application-level status code returned by the current v1 contract.

dataStatus.status (string, required): Application-level status enum returned by the current v1 contract.

dataStatus.statusDescription (string, required): Application-level status message returned by the current v1 contract.

dataStatus.responseDateTime (string, required): Response timestamp returned by the current service contract.

dataStatus.dataTotalCount (integer, required): Total number of records that match the request.

data (object, required): Health-check payload returned by the endpoint.

HTTP Status Codes:

200: Request processed successfully. Some endpoints expose a separate application-level status field in the response body, such as dataStatus.statusCode.

500: Internal service error. Retry later or contact support if the error persists.

503: Upstream service unavailable. Retry later; the requested upstream dependency is temporarily unavailable.

Business Status Codes:

The endpoint is primarily used for availability checks. Treat HTTP 200 with a valid dataStatus object as healthy.

Key Features:

Lightweight availability check for automated monitoring.

Returns the standard response envelope used by the public API.

Does not require an application key.

Suitable for uptime probes and deployment smoke checks.

Request

Request Code Samples

Responses