Developer tools
API logs

API Logs

Learn more about viewing and debugging API request logs in Knock.

Knock automatically captures and stores all of the API requests you make to the Knock API, and makes these requests accessible under the Developers > Logs section of the Knock dashboard.

Filtering API logs

#

You can filter API logs in your Knock account using the following filters:

  • Request ID: filter for a particular log returned by the X-Request-ID header.
  • Status: filter for failed and succeeded requests.
  • Endpoint type: filter for requests to particular sets of endpoints.

Log truncation

#

Knock truncates logs with long binaries, lists, maps, and strings to prevent the logs from becoming too large. The truncation occurs at the top level of the JSON object and is noted by the presence of either the __knock_truncated__ key in the JSON object (indicating that some of the keys were dropped) or as a [TRUNCATED] value under a given key.

Frequently asked questions

#

Knock will only keep 30 days of API logs available to be queried and displayed at any time.