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
  • Main Features
  • Module Components
  • Conclusion
  1. Analysis
  2. TOOLBOX

API Endpoints

The API Endpoints module enables efficient data integration by managing customizable endpoints with advanced filtering, aggregation, and connectivity options.

The API Endpoints module in AlphaX Cloud serves as a dynamic interface for managing and accessing data streams through customized API endpoints. It is essential for developers and integrators to pull data efficiently and securely for various operational needs, ensuring flexibility and reliability in data consumption.

Main Features

  1. Endpoint Listings The module provides a tabular list of all created API endpoints, showing critical attributes like:

    • Entity: The organization or project associated with the endpoint.

    • Type: Specifies the endpoint type (e.g., Conduit V7).

    • Name: The custom name assigned to the endpoint for identification.

    • URL: Displays the endpoint URL to facilitate integration with external systems.

  2. Create New Endpoint The Create Endpoint modal guides users through the setup of new API endpoints. Key configurable parameters include:

    • Endpoint Name: A descriptive identifier for the endpoint.

    • Type: Endpoint type selection, such as Conduit V7.

    • Entity: Linking the endpoint to an organization or project.

    • Tag Filter: Filters data by tags for granular control.

    • Data Time Range: Defines the period for data retrieval (e.g., last 24 hours).

    • Limit: Specifies the number of data points fetched.

    • Timezone: Configures the timezone for data relevance.

    • Group and Aggregate By: Enables data aggregation for efficient usage.

  3. Edit API Endpoint This feature allows modifications to existing API endpoints through the Edit Modal, where users can:

    • Adjust endpoint configurations.

    • Update filters, time ranges, or aggregation options.

    • Save changes seamlessly without disrupting existing operations.

Module Components

  1. List View Displays all API endpoints with detailed metadata, providing:

    • Quick access to endpoint URLs.

    • Visibility into the association of endpoints with entities and types.

  2. Manage View Offers options to:

    • Activate or deactivate endpoints.

    • Clone existing configurations for faster setups.

    • Delete unwanted endpoints securely.

  3. Data Aggregation Advanced settings include:

    • Pre-aggregation options to reduce processing overhead.

    • Flexible grouping mechanisms for structured data retrieval.

Conclusion

The API Endpoints module is a robust tool designed for efficient data sharing and integration within the AlphaX ecosystem. By enabling seamless setup, management, and customization, it supports streamlined operations and enhances connectivity with external systems.

PreviousDevices Manage ViewNextAPI Endpoints List View

Last updated 4 months ago