Guides
  1. Getting Started

Request Tracking

Request Tracking with Request ID

To enable end-to-end observability and simplify debugging, our APIs support Request ID–based tracing. This allows you to track a request as it flows through the gateway, domain services, and downstream systems.

What is Request ID?

A Request ID is a unique identifier associated with each API request. It helps in:

  • Tracing a request across multiple services
  • Debugging failures and timeouts
  • Correlating logs across distributed systems

In our system, this identifier is logged as a correlationId.

How it works

  • Include a Request ID in the request header using x-request-id.
  • The same ID is propagated automatically across all downstream services.
  • All services log this value as correlationId, enabling end-to-end traceability.
  • If no Request ID is provided, the system will automatically generate one for the request.

Header

Header NameRequiredDescription
x-request-idNoUnique identifier for the request. Logged as correlationId across systems

Example

Request

POST /graphql
Host: api.example.com
x-request-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json

Behavior

  • The provided x-request-id is propagated downstream.
  • All related logs across services will include:
correlationId:123e4567-e89b-12d3-a456-426614174000