Skip to main content

Keeping Track of a Request

For full traceability we keep track of non-sensitive metadata aspects of your requests as well as non-sensitive metadata around intermediate processing steps we perform on your behalf.

If you wish to investigate the details of what transpired for a particular request (whether successful or failed), please contact support@orgvue.com and provide the value of our tracking identity variable X-Amzn-Trace-Id, which can be extracted from responses you receive.

Extracting the tracking id​

X-Amzn-Trace-Id Header​

The tracking id is present in the headers of all responses that you receive directly from our API.

These include:

  • successful responses containing jobTickets in the "created" state.
  • unsuccessful responses containing jobTickets in the "failed" state.
  • successful responses containing export data if you called the export API synchronously.
  • all user or server error responses.

Please extract the value of the X-Amzn-Trace-Id header and share it with our customer support team.

X-Amzn-Trace-Id JSON key​

Additionally to the X-Amzn-Trace-Id header for responses that produce a jobTicket in application/json format, the tracking id is also available in the $.X-Amzn-Trace-Id field of the jobTicket.

This allows you to track the originating request while polling a jobTicket whose status is updating due to the ongoing processing in the background.

{
  "_links": {
    "self": {
      "url": "https://uniquelinktoobjectlocation.com/",
      "contentType": "application/json; charset=UTF-8",
      "type": "downloadLink"
    }
  },
  "jobStatus": "created|running|failed|completed",
  "_createdAt": "2022-06-29T20:28:04.274Z",
  "_createdBy": "your.user@orgvue.com",
  "X-Amzn-Trace-Id": "Root=1-62bcb5d3-3b211f8616879dea3bde593f"
}

Tracking across the lifecycle of your request​

flowchart image