Provide a concise and descriptive title that summarizes the issue. For example, "API response returning incorrect data" or "API endpoint returning 500 Internal Server Error.
Specify the exact API endpoint and version that you encountered the issue with. If applicable, mention the HTTP method (GET, POST, PUT, DELETE) used.
Provide the relevant details of the API request, including the request headers, request parameters, and payload (if applicable). Ensure you include all the necessary information required to reproduce the problem
Include the response received from the API, including the response headers, response status code, and response body (if applicable). If the response contains an error message or unexpected data, include that information as well
Clearly describe what you expected the API to do or return in response to the request. This helps the developers understand the intended behavior and compare it to the observed behavior
Mention the environment in which the issue occurred, such as the operating system, browser or client application version, programming language, and any relevant software versions. This information helps in reproducing the issue and narrowing down potential causes
Describe the impact of the issue on your application or system. Is it a critical issue causing system downtime or a minor inconvenience?
For the speediest resolution, please include as many specifics as possible.