How to Use the Feedback Tool

The feedback tool is designed to help users provide valuable input on the API documentation. This feedback is crucial for authors to understand user experiences and make improvements.

Page Feedback

You can leave feedback on any page of the API documentation. Look for the feedback icons at the bottom of each page (Exception: API Documentation Pages).

You'll see the prompt: "Do you like this page?" with three emotion pictures.

When you click on one of the images, the feedback extends to read: "Which statement describes your thoughts about this page?"

You can then select one of three boxes:

Additionally, there is a free text comment box. The question for the comment box changes depending on the emotion you select.

API Documentation Feedback

For the API documentation, there are two feedback options:

1. General Page Feedback:
   This works the same way as the page feedback described above.

2. Endpoint-Specific Feedback:
   Each endpoint has the same feedback mechanism as the page feedback with the emotion choices and option to leave a comment. This can be found at the bottom of each endpoint section.

Additionally, request and response code sections have a feedback option. Users can click on a box that says "What is wrong with this code?"

Clicking on this box opens a free text comment box for users to write their feedback, which will be linked to the specific endpoint.

We appreciate your feedback and look forward to improving our documentation with your help!