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
  • Modal Layout
  • Additional Features
  1. Data Hub
  2. API Queries

API Queries Modal View

The Create/Edit API Endpoint modal is a comprehensive interface that allows users to configure API queries with precision.

PreviousAPI Queries List ViewNextTesting API Queries

Last updated 7 months ago

Modal Layout

Modal Header:

  • Title: "Create New API Endpoint" or "Edit API Endpoint", depending on the action.

  • Close Button: A small "X" icon in the top right corner to close the modal without saving changes.

Modal Body:

  • Endpoint Name:

    • Label: "Endpoint Name *" indicates a required field.

    • Input Field: A text box where users can enter a descriptive name for the API endpoint.

Note: Name is a required field. You will not be able to save if this field is blank.

Type:

  • Label: "Type *" indicates a required field.

Note: Type is a required field. You will not be able to save if this field is blank.

  • Label: "Entity *" indicates a required field.

  • Dropdown Menu: Allows users to select the entity to which the API query is related. The example shows "Minnovation" selected. This field has a dual role and allocates the API query to the hierarchy and also filters the data to be specific to this entity and any data below it.

Note: Entity is a required field. You will not be able to save if this field is blank.

IMPORTANT: Allocate this field to be the lowest level entity required to access the data you are interested in. Using entities higher in your structure will cause more data to be retrieved and potentially slow or limit the query.

Tag Filter:

  • Label: "Tag Filter" with an "i" icon for additional information.

  • Input Field: A text box where users can enter specific tags to filter the API query results.

  • Info Icon: Clicking the "i" icon provides dynamic information about how to use tag filters effectively.

  • Data Time Range:

    • Label: "Data Time Range" with an "i" icon for additional information.

    • Dropdown Menu: Options for selecting the time range of data, such as "Last 24 Hours".

    • Info Icon: Clicking the "i" icon offers additional details on how the time range impacts the data retrieved.

Limit:

  • Label: "Limit (0: No Limit)" with an "i" icon for more information.

  • Input Field: A numeric input box where users can set the limit for the number of data points returned by the API query.

  • Info Icon: Clicking the "i" icon provides guidelines on setting limits for data retrieval.

Timezone:

  • Label: "Timezone"

  • Dropdown Menu: Allows users to select and nothe timezone for the data. The example shows "User Default Timezone (Australia/Melbourne)".

Group By:

  • Label: "Group By"

  • Dropdown Menu: Users can choose a parameter by which to group the data, such as by minute , hour, day, week, month, year

Aggregate By:

  • Label: "Aggregate By"

  • Dropdown Menu: Options for aggregating data, such as sum, avg, max, min, range, diff

Multi-Stage Aggregation:

  • Button: "+ Pre Aggregate"

  • Function: Clicking this button allows users to add multi-stage aggregations, enabling more complex data manipulation as per the developer documentation.

Modal Footer:

  • Cancel Button: Located at the bottom left, allows users to cancel the creation or editing of the API endpoint and close the modal without saving changes.

  • Create/Save Button: Located at the bottom right, labeled "Create" or "Save" depending on the action, to confirm and save the API endpoint configuration.

Additional Features

  • Dynamic Information: Clicking on any "i" icons next to the labels provides context-sensitive help and additional information about how to use each field effectively. This ensures users have the guidance they need to configure their queries accurately.

  • Multi-Stage Aggregations: The "+ Pre Aggregate" button allows for the addition of multi-stage aggregations, enabling users to perform advanced data manipulations. This feature aligns with the detailed guidelines available in the developer documentation, ensuring users can implement complex data analysis directly within the API query configuration.

By following the structured fields and utilising the help icons, users can create or edit API endpoints with precision, ensuring their queries are tailored to their specific needs.

Dropdown Menu: Default set to "Conduit V7", users can select from different output formats depending on their access levels and account. See for more information on output formats.

Refer to for a full description of grouping parameters.

Refer to for a full description of aggregation parameters.

Refer to for a full description of multi-stage aggregation parameters.

developer docs
developer docs
developer docs
developer docs