Documentation

requests.peek() function

requests.peek() is experimental and subject to change at any time.

requests.peek() converts an HTTP response into a table for easy inspection.

Deprecated

Experimental requests.peek is deprecated in favor of requests.peek.

The output table includes the following columns:

  • body with the response body as a string
  • statusCode with the returned status code as an integer
  • headers with a string representation of the headers
  • duration the duration of the request as a number of nanoseconds

To customize how the response data is structured in a table, use array.from() with a function like json.parse(). Parse the response body into a set of values and then use array.from() to construct a table from those values.

Function type signature
(
    response: {A with statusCode: E, headers: D, duration: C, body: B},
) => stream[{statusCode: E, headers: string, duration: int, body: string}]

For more information, see Function type signatures.

Parameters

response

(Required) Response data from an HTTP request.

Examples

Inspect the response of an HTTP request

import "experimental/http/requests"

requests.peek(response: requests.get(url: "https://api.agify.io", params: ["name": ["natalie"]]))

View example output


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: