Skip to main content

Response payload

The response payload is the data received. In order to ease readability, payloads can be displayed as they are (raw mode) or hex-encoded (hex mode). Some payloads can be also formatted using syntax coloration and other options (pretty mode) or in a preview mode:

  • raw displays the bytes of the payloads. It may produce unwanted effects when applied on "binary" payloads.
  • hex displays each byte of the payload in their hexadecimal representation.
  • preview fits very well with images, HTML payloads, etc. The browser is asked to render the payload according to its media type. Binary files are not rendered.
  • pretty supports various options such as syntax coloration. They are specified in the table below.

The raw and hex modes are available for all kinds of payloads. The preview mode is available for the HTML payloads, images and Binary. In the latter case, it simply displays a message saying that binary files cannot be previewed.

Here is the availability of the pretty mode options:

Payload type Syntax coloration Line numbers Expand/collapse nodes Clickable URLs
XML Available Available Available Available
JSON Available Available Available Available
HTML Available Not available Not available Available

In API Tester Settings > APPEARANCE, you can configure response view options for each content type.

Appearance Settings section.

You can see the elapsed time of the request in the top right and the length of the body in the bottom right of the Response section.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!