Navigation

API Ingest Component

Connect your data pipeline directly to external REST APIs. GraphQL endpoints are supported via HTTP POST.

Last updated:

The API Ingest Component (labeled API Fetch in the palette) allows you to pull real-time data into your DataLensia pipeline. It supports various authentication methods and dynamic URL parameters.

GraphQL note: GraphQL is supported as a standard HTTP POST request. Send your query in the request body via the Headers field as Content-Type: application/json. There is no native GraphQL parser — the raw JSON response is passed downstream as-is.

⚙️ Configuration

PropertyTypeDescription
URLstringThe endpoint URL. Supports templates like https://api.example.com/users/{{id}}.
MethodenumHTTP method: GET or POST.
HeadersobjectCustom HTTP headers in JSON format (e.g., for Authorization).

🔄 Dynamic URL Resolution

You can use double curly braces {{path.to.key}} to inject values from the preceding component into your API request.

Example: If the input to this component is {"userId": 123}, setting the URL to https://jsonplaceholder.typicode.com/users/{{userId}} will fetch data for user 123.

🛡️ Security & CORS

DataLensia performs API requests directly from your browser. This means:

  1. Your API credentials never leave your browser.
  2. The target API must support CORS (Cross-Origin Resource Sharing) for the request to succeed.
  3. If CORS is not enabled on the server, you may need to use a proxy.

🚀 Pro Tip

Enable Error Pass-Through in the node settings if you want the pipeline to continue with the input data even if the API request fails or times out.