AlphaX
  • WORKSPACE
    • Data Table List View
      • AI View
    • Map
  • Analysis
    • Overview
    • Anomalies
      • Batch Detection
      • Change Point Detection
      • Streaming Detection
      • User interface
        • Anomaly List View
        • Anomaly Edit View
        • Anomaly Chart View
        • Anomaly Share View
      • Analysis List View
    • TOOLBOX
      • Analysis
        • Charts
          • Charts View
          • Drawings View
          • Data View
        • Table
        • Anomaly
      • Reports
        • Reports List View
          • Create a New Report
        • Reports Manage View
      • Device
        • Devices List View
          • Create New Device Registration
        • Devices Manage View
      • API Endpoints
        • API Endpoints List View
          • Create a New Feed
        • API Endpoints Manage View
      • Integrations
        • Integrations List View
          • App
        • Integrations Manage View
      • Dashboards
        • Dashboards List View
          • Create a New Dashboard
        • Dashboards Manage View
      • Alerts
        • Events Hub List View
        • Events Hub Manage View
        • Event Data Format
        • Event Acknowledgement
      • Calculations
        • Calculations List View
          • Create a New Calculation
        • Calculations Manage View
      • Controls
        • Controls List View
          • Create a New Control Element
        • Controls Manage View
  • Data Hub
    • API Queries
      • API Queries List View
      • API Queries Modal View
      • Testing API Queries
      • Common Issues & Troubleshooting
    • ADMINISTRATION
      • People
        • Users
          • Users List View
            • Create a New User Account
          • Users Manage View
        • Roles
          • Roles List View
            • Create a New Access Role
          • Roles Manage View
        • Contacts
          • Contacts List View
            • Create New Contact
          • Contacts Manage View
      • Configuration
        • Asset Hierarchy
          • Asset Hierarchy List View
            • Create New Entity
          • Asset Hierarchy Manage View
        • Attributes
          • Asset Classes
            • Asset Classes List View
              • Create New Asset Class
            • Asset Classes Manage View
          • Battery Types
            • Battery Types List View
              • Create New Battery Type
            • Battery Types Manage View
          • Device Categories
            • Device Categories List View
              • Create New Device Category
            • Device Categories Manage View
          • Feed Types
            • Feed Types List View
              • Create a New Feed Type
            • Feed Types Manage View
          • Manufactures
            • Manufacturers List View
              • Create a New Manufacture
            • Manufactures Manage View
          • Models
            • Models List View
              • Create a New Model
            • Models Manage View
          • Network Types
            • Network Types List View
              • Create New Network Type
            • Network Types Manage View
          • Power Sources
            • Power Sources List View
              • Create A New Power Source
            • Power Sources Manage View
          • Sensor Types
            • Sensor Types List View
              • Create New Sensor Type
            • Sensor Types Manage View
          • Status Labels
            • Status Labels List View
              • Create New Status Label
            • Status Labels Manage View
          • Suppliers
            • Suppliers List View
              • Create New Supplier
            • Suppliers Manage View
      • System Logs
        • System Logs List View
        • Email Message Log
        • SMS Message Log
        • API Transaction Log
        • Create a New Service Log Report
Powered by GitBook
On this page
  • 1. Main Interface Description
  • 2. Input Fields (Mandatory and Optional)
  • 3. Pre-Aggregation Section
  • 4. Pre-Aggregation Workflow
  • 5. Bottom Buttons
  • Conclusion
  1. Analysis
  2. TOOLBOX
  3. API Endpoints
  4. API Endpoints List View

Create a New Feed

The "Create New API Endpoint" window lets users configure API endpoints with required fields, optional settings, and advanced aggregations.

PreviousAPI Endpoints List ViewNextAPI Endpoints Manage View

Last updated 5 months ago

The "Create New API Endpoint" window enables users to create and customize API endpoints by providing required fields like Endpoint Name, Type, and Entity, along with optional settings such as Tag Filter, Data Time Range, and Pre-Aggregation. Users can add advanced grouping and aggregation configurations or delete them as needed, with options to save or cancel changes.

1. Main Interface Description

This table gives an overview of the interface and explains the basic elements like the tab title, field types, and action buttons.

Feature
Mini Description

Window Header

The title of the tab is "Create New API Endpoint", which opens upon clicking the "Create" button.

Mandatory Fields

Fields marked with a star (*) are required to proceed.

Non-Mandatory Fields

Optional fields allow additional customization of the endpoint.

Buttons

Two action buttons: Cancel to discard changes and Create to save the endpoint.

2. Input Fields (Mandatory and Optional)

This table outlines the mandatory and optional fields users need to configure when creating an API endpoint.

Mandatory Fields (Marked with *)

Field Name
Description

Endpoint Name*

Enter a unique name to identify the API endpoint.

Type*

Select the API version/type (e.g., "Conduit V7") from a dropdown.

Entity*

Choose the associated location or system from a dropdown (e.g., "Minnovation").

Optional Fields

Field Name
Description

Tag Filter

Specify tags to filter the data fetched by the API.

Data Time Range

Select a predefined time range (e.g., "Last 24 Hours").

Limit

Set the maximum number of records to fetch (0 = no limit).

Time zone

Specify the time zone for data aggregation (default: user’s time zone).

Group By

Choose grouping logic for fetched data (e.g., None, Hour, Day).

Aggregate By

Select the aggregation function for data (e.g., None, Sum, Average, Maximum).

3. Pre-Aggregation Section

This table explains the functionality of pre-aggregation, where users can define additional grouping or aggregation rules for the API data.

Feature
Description

"+ Add Pre-Aggregation"

Adds a new configuration bar to set up pre-aggregation options.

Pre-Aggregation Bar Fields

Includes two dropdowns: Pre Group (for grouping logic) and Pre Aggregate (for aggregation logic).

Pre Group

Dropdown options: None, Minute, Hour, Day, Week, Month.

Pre Aggregate

Dropdown options: None, Sum, Average, Maximum, Minimum, Range.

Delete Button

Removes a pre-aggregation bar.

4. Pre-Aggregation Workflow

This table outlines the workflow for using the "+ Add Pre-Aggregation" button to refine data through advanced grouping and aggregation settings.

Step
Description

Adding a Pre-Aggregation

Clicking the "+ Add Pre-Aggregation" button adds a new pre-aggregation bar with configurable options.

Configuring Pre-Aggregation

Users select values for Pre Group (e.g., Hour) and Pre Aggregate (e.g., Sum).

Deleting a Pre-Aggregation

The delete button removes a pre-aggregation bar.

5. Bottom Buttons

This table describes the two bottom buttons used to either save or cancel the API creation process.

Button Name
Description

Cancel

Exits the "Create New API Endpoint" interface without saving changes.

Create

Saves the configured API endpoint and closes the window.

Conclusion

The "Create New API Endpoint" window allows users to configure a new API connection by providing mandatory fields such as Endpoint Name, Type, and Entity. Additional optional settings, including Tag Filter, Data Time Range, Group By, and Aggregate By, can further customize the endpoint. Users can also add pre-aggregation logic and finalize the setup with the Create or Cancel button.

Create New API Endpoint View