Trace IDs

Trace IDs (X-Request-ID)

Oyster supports trace IDs to help you correlate API requests with their corresponding responses for debugging and monitoring purposes. This feature is particularly useful for measuring API latency and troubleshooting issues.

How to Use Trace IDs

To include a trace ID in your API requests, add the X-Request-ID header to your HTTP requests. The header value must meet the following requirements:

Length: Between 20 and 200 character
Characters: ASCII letters, digits, or the characters +, /, =, and -
Format: Any valid string meeting the above criteria

Example:

curl --request GET \
     --url https://api.oysterhr.com/v0.1/engagements \
     --header 'accept: application/json' \
     --header 'X-Request-ID: trace-12345-67890-abcdef'

Notes

Invalid trace IDs (those not meeting the format requirements) will be ignored and replaced with system-generated ones
Trace IDs are optional - your API calls will work normally without them
This feature is available to all API users and does not require special configuration