Request IDs & Correlation

Every API request includes identifiers used for tracing, debugging, and support.

Response Headers

HeaderDescription
X-HG-Request-IdUnique ID generated by Health Gorilla for this request
X-Request-IdSame value as X-HG-Request-Id, not the value you sent
X-Correlation-IdYour X-Request-Id value, returned when your request includes one

How They Work Together

  • Include X-Request-Id in your request
  • Health Gorilla generates X-HG-Request-Id
  • X-Correlation-Id connects the client and server request IDs

Best Practices

  • Include X-Request-Id on all requests
  • Log X-HG-Request-Id and X-Correlation-Id in your application logs
  • Provide these IDs when contacting Health Gorilla support