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. Header
  • 2. Editable Fields
  • 3. Pre-Aggregation Section
  • 4. Bottom Action Buttons
  • 5. Key Features
  • Conclusion
  1. Analysis
  2. TOOLBOX
  3. API Endpoints

API Endpoints Manage View

The Manage View lets users edit API endpoint details, update configurations, add pre-aggregations, and save or cancel changes.

PreviousCreate a New FeedNextIntegrations

Last updated 4 months ago

The Manage View: Edit API Endpoint window allows users to modify an existing API endpoint. It includes mandatory fields like Endpoint Name, Type, and Entity, along with optional fields such as Tag Filter, Data Time Range, and Pre-Aggregation options. Users can save updates with the Save button or cancel changes to retain original settings.

1. Header

This table describes the header, which specifies the purpose of the window.

Feature
Description

Window Title

The window is titled "Edit API Endpoint", indicating it is for modifying an existing API configuration.

2. Editable Fields

Mandatory Fields (Marked with *)

This table lists the mandatory fields that must be filled out or updated when editing an API endpoint.

Field Name
Description

Endpoint Name*

Displays the current name of the API endpoint. Can be renamed if needed.

Type*

Dropdown showing the current API type (e.g., "Conduit V7"). Can be changed to a different type.

Entity*

Dropdown showing the associated entity or location (e.g., "Minnovation"). Can be updated if required.

Optional Fields

This table describes the optional fields users can modify to customize the endpoint's configuration further.

Field Name
Description

Tag Filter

A field for specifying tags to filter the data. Can be edited or left blank.

Data Time Range

Dropdown to define the time range for data (e.g., "Last 24 Hours"). Can be set to "None."

Limit

Numeric input to specify the maximum number of records fetched (0 = no limit).

Time zone

Dropdown to select a time zone for aggregation (Default: User’s time zone).

Group By

Dropdown for grouping data (e.g., None, Minute, Hour, Day).

Aggregate By

Dropdown for selecting aggregation functions (e.g., None, Sum, Average, Maximum).

3. Pre-Aggregation Section

This table explains the pre-aggregation functionality, allowing users to define advanced grouping and aggregation rules.

Feature
Description

+ Add Pre-Aggregation

Adds a new bar for configuring advanced grouping and aggregation.

Pre Group

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

Pre Aggregate

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

Delete Button

Removes the pre-aggregation bar if it’s no longer needed.

4. Bottom Action Buttons

This table outlines the bottom action buttons, allowing users to either save changes or cancel edits.

Button Name
Description

Cancel

Discards any changes made and exits the Edit API Endpoint window.

Save

Saves the modifications and updates the API endpoint in the main table.

5. Key Features

This table summarizes the key features that make the Edit API Endpoint window user-friendly and flexible.

Feature
Description

User-Friendly Design

Fields are pre-filled with the current configurations, enabling quick edits.

Flexible Configuration

Allows updates to basic details (e.g., name, entity) and advanced settings (e.g., aggregation).

Data Integrity

Users can cancel changes at any time to keep the original configuration intact.

Conclusion

The Manage View: Edit API Endpoint offers a seamless interface for modifying existing API configurations. It balances user-friendliness with powerful customization options, ensuring users can easily refine API settings to suit their data integration needs. By including clear options for grouping, aggregation, and filtering, along with intuitive controls for saving or discarding changes, this view empowers users to manage their API endpoints efficiently and confidently.

Edit API Endpoint View