Request tracing
X-Request-ID
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 regardless of whether it is a success or a failure.
While you can use any string as the request identifier, HERE recommends using a UUID to uniquely identify your requests or groups of requests.
X-Correlation-Id
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-IdorX-Correlation-Idwhen 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-Idto identify the correlation. - If you have your own request tracing identifier, you can pass this value as the
X-Request-Idto continue the tracing through our service.
Updated last month