Debug your APIs using request tracing

This tutorial describes how to inspect request processing to help you with debugging and troubleshooting your API.

In this tutorial, you learn how to:

  • Trace a call

API inspector


Trace a call

API tracing

  1. Select APIs.

  2. Click Demo Conference API from your API list.

  3. Switch to the Test tab.

  4. Select GetSpeakers operation.

  5. Make sure to include an HTTP header named Ocp-Apim-Trace with the value set to true.


    • If Ocp-Apim-Subscription-Key is not automatically populated, you can retrieve it by going to the Developer Portal and exposing the keys on the profile page.
    • To get a trace when the Ocp-Apim-Trace HTTP header is used, the Allow tracing setting for the subscription key must be enabled. To configure the Allow tracing setting, under API Management in the left menu, select Subscriptions. Allow tracing on the API Management Subscriptions pane
  6. Click Send to make an API call.

  7. Wait for the call to complete.

  8. Go to the Trace tab in the API console. You can click any of the following links to jump to detailed trace info: inbound, backend, outbound.

    In the inbound section, you see the original request API Management received from the caller and all the policies applied to the request including the rate-limit and set-header policies we added in step 2.

    In the backend section, you see the requests API Management sent to the API backend and the response it received.

    In the outbound section, you see all the policies applied to the response before sending back to the caller.


    Each step also shows the elapsed time since the request is received by API Management.

Next steps

In this tutorial, you learned how to:

  • Trace a call

Advance to the next tutorial: