# Create a New Feed

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.

<figure><img src="/files/2xPky4H5D7LbuOweKzYW" alt=""><figcaption><p>Create New API Endpoint View</p></figcaption></figure>

### **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.

<table><thead><tr><th width="227">Feature</th><th>Mini Description</th></tr></thead><tbody><tr><td><strong>Window Header</strong></td><td>The title of the tab is <strong>"Create New API Endpoint"</strong>, which opens upon clicking the "Create" button.</td></tr><tr><td><strong>Mandatory Fields</strong></td><td>Fields marked with a star (<code>*</code>) are required to proceed.</td></tr><tr><td><strong>Non-Mandatory Fields</strong></td><td>Optional fields allow additional customization of the endpoint.</td></tr><tr><td><strong>Buttons</strong></td><td>Two action buttons: <strong>Cancel</strong> to discard changes and <strong>Create</strong> to save the endpoint.</td></tr></tbody></table>

### **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 `*`)**

<table><thead><tr><th width="197">Field Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>Endpoint Name</strong>*</td><td>Enter a unique name to identify the API endpoint.</td></tr><tr><td><strong>Type</strong>*</td><td>Select the API version/type (e.g., "Conduit V7") from a dropdown.</td></tr><tr><td><strong>Entity</strong>*</td><td>Choose the associated location or system from a dropdown (e.g., "Minnovation").</td></tr></tbody></table>

**Optional Fields**

<table><thead><tr><th width="197">Field Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>Tag Filter</strong></td><td>Specify tags to filter the data fetched by the API.</td></tr><tr><td><strong>Data Time Range</strong></td><td>Select a predefined time range (e.g., "Last 24 Hours").</td></tr><tr><td><strong>Limit</strong></td><td>Set the maximum number of records to fetch (0 = no limit).</td></tr><tr><td><strong>Time zone</strong></td><td>Specify the time zone for data aggregation (default: user’s time zone).</td></tr><tr><td><strong>Group By</strong></td><td>Choose grouping logic for fetched data (e.g., None, Hour, Day).</td></tr><tr><td><strong>Aggregate By</strong></td><td>Select the aggregation function for data (e.g., None, Sum, Average, Maximum).</td></tr></tbody></table>

### **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.

<table><thead><tr><th width="255">Feature</th><th>Description</th></tr></thead><tbody><tr><td><strong>"+ Add Pre-Aggregation"</strong></td><td>Adds a new configuration bar to set up pre-aggregation options.</td></tr><tr><td><strong>Pre-Aggregation Bar Fields</strong></td><td>Includes two dropdowns: <strong>Pre Group</strong> (for grouping logic) and <strong>Pre Aggregate</strong> (for aggregation logic).</td></tr><tr><td><strong>Pre Group</strong></td><td>Dropdown options: <code>None</code>, <code>Minute</code>, <code>Hour</code>, <code>Day</code>, <code>Week</code>, <code>Month</code>.</td></tr><tr><td><strong>Pre Aggregate</strong></td><td>Dropdown options: <code>None</code>, <code>Sum</code>, <code>Average</code>, <code>Maximum</code>, <code>Minimum</code>, <code>Range</code>.</td></tr><tr><td><strong>Delete Button</strong></td><td>Removes a pre-aggregation bar.</td></tr></tbody></table>

### **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.

<table><thead><tr><th width="281">Step</th><th>Description</th></tr></thead><tbody><tr><td><strong>Adding a Pre-Aggregation</strong></td><td>Clicking the <strong>"+ Add Pre-Aggregation"</strong> button adds a new pre-aggregation bar with configurable options.</td></tr><tr><td><strong>Configuring Pre-Aggregation</strong></td><td>Users select values for <strong>Pre Group</strong> (e.g., Hour) and <strong>Pre Aggregate</strong> (e.g., Sum).</td></tr><tr><td><strong>Deleting a Pre-Aggregation</strong></td><td>The delete button removes a pre-aggregation bar.</td></tr></tbody></table>

### **5. Bottom Buttons**

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

<table><thead><tr><th width="173">Button Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>Cancel</strong></td><td>Exits the "<strong>Create New API Endpoint</strong>" interface without saving changes.</td></tr><tr><td><strong>Create</strong></td><td>Saves the configured <strong>API endpoint</strong> and closes the window.</td></tr></tbody></table>

### **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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://minnovation-1.gitbook.io/alphax/analysis/toolbox/api-endpoints/api-endpoints-list-view/create-a-new-feed.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
