Web API Data Stream Parameters

The WebAPI plugin provides a single configurable data stream: HTTP Request. Use the parameters to configure the request to send to an API endpoint.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Configuration tabs

To configure this data stream, you must work your way through each of the following tabs configuring each one as needed.

Basics

Use the Basics tab to configure the type pf request and the endpoint that the request is sent to.

Parameter
Description
Type
Select the type of request to send. This determines how the request is structured and how the remote server processes it. The type you should select depends on what the API you are querying is expecting. Choose from:
  • GET: Select to simply fetch data from an endpoint.
  • POST: Select to send data (such as JSON or form data) to the endpoint.
Base URL
This value is read-only and is determined by entering the Base URL when configuring the data source. It represents the root address of the target API or service. The final request URL is built by combining this base URL with the specified Path.
Path
Enter the specific resource or route (for example, /v1/data or /users/list) that identifies where the request should be sent. This field allows flexibility to target different endpoints under the same base URL.

Body

Use the Body tab to the content sent in the body of a POST request. This tab only displays when POST is selected on the Basics tab.

  • Body: Enter the data payload to include in the request body. The format typically depends on the API requirements and the Content-Type header.

Parameters

Use the Parameters tab to add key:value pairs to include in the request’s query string. Query parameters are appended to the end of the URL to pass data or filter results (for example, ?status=active&limit=100).

Parameter
Description
Add new query parameter /
Add another query parameter
Click to add a set of key:value parameter fields.
MyParam
Enter the name (key) of the parameter. For example, status.
123
Enter the value of the parameter. For example, 100. You can click the Encrypt
/ Decrypt
icon to toggle the encryption of the parameter value.

Headers

Use the Headers tab to add custom HTTP headers to include in the request. Headers provide additional metadata or configuration details for the HTTP request (for example, authentication tokens, content type, or custom app identifiers).

Parameter
Description
Add new header /
Add header
Click to add a set of key:value header fields.
MyHeader
Enter the name (key) of the header. For example, Content-Type.
123
Enter the value of the header. For example, application/json.

Response

Use the Response tab to display the response returned from the configured HTTP request and to optionally configure the data path.

Parameter
Description
Response preview
After clicking the Send button, this field displays the raw JSON response or any error message generated by the request. Use this preview to verify that the endpoint is reachable and that the returned data matches your expectations.
Path to data
Enter the exact path (for example, data.items or results[0].value) to select the portion of the response you want to use. This helps locate and process only the relevant part of the response payload.
Expand inner objects
When selected, any nested structures in the response data are expanded. Deselect to collapse and simplify the display of deeply nested data.

Examples

The following examples aim to guide how to populate each of the Configuration tabs to build your HTTP requests.

The following examples use dummy data and are for purely demonstrative purposes. The exact format of expected parameters / headers depends entirely on the API you are querying and you should refer to that API's documentation.

GET request to retrieve user data

Fetch a list of users from a public API with optional filters.

  1. On the Basics tab, configure the following:
    • Type: GET
    • URL: https://api.example.com (read-only)
    • Path: /v1/users
  2. On the Parameters tab, configure the following, this defines the following for the resulting request URL https://api.example.com/v1/users?status=active&limit=50:
    Name
    Value
    status
    active
    limit
    50
  3. On the Headers tab, configure the following:
    Name
    Value
    Accept
    application/json
    Authorization
    Bearer {{api_token}}
  4. On the Response tab, configure the following:
    • Response Preview: Click Send to displays JSON such as
      {
  "data": [
    { "id": 1, "name": "Alice" },
    { "id": 2, "name": "Bob" }
  ],
  "total": 2
}
    • Path to Data: data
    • Expand Inner Objects: Toggle on to view full user details

POST request to query analytics data

  1. On the Basics tab, configure the following:
    • Type: POST
    • URL: https://api.example.com (read-only)
    • Path: /v1/sales/query
  2. On the Body tab, configure the following:
    • Body: This request asks the API to return aggregated sales metrics for a specific date range and region
      {
  "startDate": "2025-11-01",
  "endDate": "2025-11-07",
  "region": "North America",
  "metrics": ["totalSales", "averageOrderValue", "transactions"]
}
  3. On the Parameters tab, leave the fields empty, as query parameters are included in the request body for this API.
  4. On the Headers tab, configure the following:
    Name
    Value
    Content-Type
    application/json
    Authorization
    Bearer {{api_token}}
    Accept
    application/json
  5. On the Response tab, configure the following:
    • Response Preview: Click Send to display JSON such as
      {
  "status": "success",
  "data": {
    "summary": {
      "totalSales": 157340.25,
      "averageOrderValue": 78.12,
      "transactions": 2014
    },
    "dailyBreakdown": [
      { "date": "2025-11-01", "totalSales": 22000.50 },
      { "date": "2025-11-02", "totalSales": 24350.00 },
      { "date": "2025-11-03", "totalSales": 18000.75 }
    ]
  }
}
    • Path to Data:data.dailyBreakdown
    • Expand inner objects: Toggle on to view nested objects like summary and dailyBreakdown

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket