Documentation

http.endpoint() function

http.endpoint() iterates over input data and sends a single POST request per input row to a specified URL.

This function is designed to be used with monitor.notify().

http.endpoint() outputs a function that requires a mapFn parameter. mapFn is the function that builds the record used to generate the POST request. It accepts a table row (r) and returns a record that must include the following properties:

  • headers
  • data

For information about properties, see http.post.

Function type signature
(
    url: string,
) => (mapFn: (r: A) => {B with headers: C, data: bytes}) => (<-tables: stream[A]) => stream[{A with _sent: string}] where C: Record
  • Copy
  • Fill window

For more information, see Function type signatures.

Parameters

url

(Required) URL to send the POST request to.

Examples

Send an HTTP POST request for each row

import "http"
import "sampledata"

endpoint =
    http.endpoint(url: "http://example.com/")(
        mapfn: (r) =>
            ({
                headers: {header1: "example1", header2: "example2"},
                data: bytes(v: "The value is ${r._value}"),
            }),
    )

sampledata.int()
    |> endpoint()
  • Copy
  • Fill window

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.

Read more

InfluxDB 3 Core and Enterprise are now in Beta

InfluxDB 3 Core and Enterprise are now available for beta testing, available under MIT or Apache 2 license.

InfluxDB 3 Core is a high-speed, recent-data engine that collects and processes data in real-time, while persisting it to local disk or object storage. InfluxDB 3 Enterprise is a commercial product that builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries. A free tier of InfluxDB 3 Enterprise will also be available for at-home, non-commercial use for hobbyists to get the full historical time series database set of capabilities.

For more information, check out: