HTTP

With the HTTP connection you can poll an API endpoint. It is also supported to define one or more JSON paths to extract specific values or objects from a JSON response.

Connection address

In the connection address you enter the base address. If you specify absolute addresses in the variable mappings, you can enter any non-empty value here.

Variable mapping

The mapping is either a relative path (using the connection address as base), or an absolute address (starting with http or https).

You can extract a specific JSON value or object by appending the URL with |, followed by the json path. Example: http://www.myapp.com/api/getdata|$.results This will take the results property of the JSON object returned by http://www.myapp.com/api/getdata

You can add multiple variables with the same address, but different JSON paths. However, this will poll the URL once for each variable. To improve efficiency you can add a variable with the address (no JSON path), and add child variables with only the JSON paths. This way, the endpoint will be polled only once per cycle, extracting variable data for each child variable.

Poll cycle

By default Capture Edge will sleep for 30 seconds after each poll cycle. This can be changed by setting the Read cycle delay on the General page of the connection.

Special data types

You can find a list of special data types the connection can handle here.