requests.get() function
requests.get()
is experimental and subject to change at any time.
requests.get()
makes a http GET request. This identical to calling request.do(method: "GET", ...)
.
Deprecated
Experimental requests.get
is deprecated in favor of requests.get
.
Function type signature
(
url: string,
?body: bytes,
?config: {A with timeout: duration, insecureSkipVerify: bool},
?headers: [string:string],
?params: [string:[string]],
) => {statusCode: int, headers: [string:string], duration: duration, body: bytes}
Parameters
url
(Required) URL to request. This should not include any query parameters.
params
Set of key value pairs to add to the URL as query parameters. Query parameters will be URL encoded. All values for a key will be appended to the query.
headers
Set of key values pairs to include on the request.
body
Data to send with the request.
config
Set of options to control how the request should be performed.
Examples
Make a GET request
import "experimental/http/requests"
response = requests.get(url: "http://example.com")
requests.peek(response: response)
Make a GET request and decode the JSON response
import "experimental/http/requests"
import "experimental/json"
import "array"
response = requests.get(url: "https://api.agify.io", params: ["name": ["nathaniel"]])
// api.agify.io returns JSON with the form
//
// {
// name: string,
// age: number,
// count: number,
// }
//
// Define a data variable that parses the JSON response body into a Flux record.
data = json.parse(data: response.body)
// Use array.from() to construct a table with one row containing our response data.
// We do not care about the count so only include name and age.
array.from(rows: [{name: data.name, age: data.age}])
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Flux and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.