Create a New Feed

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

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.

Create New API Endpoint View

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.