Request tracing


You can tag your requests with a request identifier using the non-standard HTTP header X-Request-Id. The service will forward this value to the response, be it a success or a failure. If no value is provided, a UUID will be generated on the incoming request, and its value will be attached to the response as the X-Request-Id. While you can use any string as the request identifier, we recommend using a UUID to uniquely identify your requests or groups of requests.


In addition to the X-Request-Id http header, the service response will also carry a X-Correlation-Id http header. This is an auto-generated identifier that is unique to every request.

Request tracing use cases

The following are request tracing use cases:

  • You can provide either the X-Request-Id or X-Correlation-Id when filing a bug or posting a question about a specific request to our support service.
  • A group of correlated requests could be tagged with the same X-Request-Id to identify the correlation.
  • If you have your own request tracing identifier, you can pass this value as the X-Request-Id to continue the tracing through our service.

results matching ""

    No results matching ""