Launch Firecamp

07. Response Panel

Overview of the Response Panel of the API app


Overview

The response panel in the Firecamp API app is to view the information/data received as part of the response by the server when a request has been made.

The panel provides a clear eagle-eye view of your response body as well as features to dive deeper into headers, cookies, timeline and performance benchmarks associated with your request.

Response Panel

Viewing the Response is not limited to only JSON/Text. Response body can be HTML, JSON, XML, Text, Image, GIF. Options like copy, fold and word wrap are also available through the utility icons. That way the API response body can be viewed, and styled as needed.

The response headers, cookies, and timelines for the response can be viewed by toggling through tabs. The copy json and copy text can be used to copy information in any format that is required.

Headers

Response Panel headers

Response Headers are essentially metadata of the response. Here's how the response headers are represented under the Headers tab in Firecamp API app.

{
  "access-control-allow-credentials": "true",
  "age": "6792",
  "cache-control": "max-age=14400",
  "cf-cache-status": "HIT",
  "cf-ray": "565bd15eff0dddd3-SIN",
  "content-type": "application/json; charset=utf-8",
  "date": "Sun, 16 Feb 2020 01:41:12 GMT",
  "etag": "W/\"6b80-Ybsq/K6GwwqrYkAsFxqDXGC7DoM\"",
  "expect-ct": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"",
  "expires": "-1",
  "pragma": "no-cache",
  "server": "cloudflare",
  "vary": "Origin, Accept-Encoding",
  "via": "1.1 vegur",
  "x-content-type-options": "nosniff",
  "x-powered-by": "Express"
}

Cookies

Cookies are used for session management. Information regarding cookies can be accessed through the Cookies tab in the response panel.

Response Panel Cookies

Timeline

Timeline tab in Firecamp helps developers get an overview on their request. Timeline provides session information, request and response headers, size of response data received, server certificates and more. This goes to be a great tool to debug response of your API's as it provides all information in a raw and compiled form.

Response Panel Timeline

Performance Benchmarks

Response Panel Performance

The performance benchmarks listed on the response panel helps the user know more about API's performance traits. The first number being the status code returned, next being the response time of the API listed in milliseconds and last being the data transferred in kilobytes.

API app in Firecamp returns an appropriate status code so that the user can know the actual issue and process accordingly.

1. 1XX Codes: Informational Codes
2. 2XX Codes: Success Codes
3. 3XX Codes: URL Redirection
4. 4XX Codes: Error Codes
5. 5XX Codes: Server error
Edit on GitHub