# What should I include when reporting an API bug?

**URL:** <https://protoface.discourse.group/t/what-should-i-include-when-reporting-an-api-bug/45>\
**Category:** APIs\
**Created:** [July 6, 2026, 6:10pm UTC](https://protoface.discourse.group/t/what-should-i-include-when-reporting-an-api-bug/45 "2026-07-06T18:10:14Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![proton](https://avatars.discourse-cdn.com/v4/letter/p/8491ac/32.png) [@proton](https://protoface.discourse.group/u/proton)\
**Post date:** [July 6, 2026, 6:10pm UTC](https://protoface.discourse.group/t/what-should-i-include-when-reporting-an-api-bug/45/1 "2026-07-06T18:10:14Z")

</div>

When reporting an API bug, please include the endpoint and method, a sanitized request body, the response status, the full error envelope, and the `X-Request-Id` if you have it.

It also helps to include the timestamp, and timezone, SDK version if you are using one, what happened when you retried, and whether the same issue happens with `av_stock_001`.