Setup and Usage

The first thing that is needed to do to make use of an API Exporter operator is to link one into a new or existing pipeline.

The light-blue circle therein (In the top-right corner of the Sample REST API icon) means that the operator was not run. This can be solved by clicking the green "Run" button to run the entire pipeline (see the top-bottom corner of the picture) or clicking the individual "play" button while hovering over the Sample REST API operator, but first the operator needs to be configured.

In order to edit the operator's configuration, hovering over the operator also displays the option, with a clickable pencil icon (at the top-right corner, the "play" icon is also available to run the operator individually and directly).

While setting the operator up, by clicking the pencil icon, a list of datasets can be specified (as a pair of integration and chosen stream, given from the available integrations added into the pipeline and ideally one integration directly or indirectly preceding the REST API operator). The interface will look like this:

(multiple streams can be selected to be served by the API)

Once the API is run (either by clicking the "Play" (triangle) per-operator button or by clicking the "Run" per-pipeline button), its results are stored and available through a special API endpoint and access key.

API Querying

In the "API" section in the project, the operator will be listed by providing a special endpoint as one of the list item (in this example, listed as "Sample REST API", being the first entry):

By clicking the per-element REST API button, this can be seen:

That long text (highlighted in the picture) is a sample cURL command to make use of the API. In order for this to work, the operator must have to be run in advance as detailed in the previous section.

While any HTTP API client, or even browser extension, is allowed to be used, the sample cURL command works with any curl command line already installed in the user's system (typically, this tool comes out of the box in modern Linux or Mac systems). An example of command-line usage comes below:

The output comes in JSON format and can be processed by the intended consumer (the returned data will never change - when in need of a refresh, replaying the whole pipeline or the individual operator, either manually or by schedule, will solve the issue and keep the data up to date in the endpoint).

A Python example: