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. Data Hub
  2. API Queries

API Queries List View

The API Endpoints page provides a comprehensive and user-friendly interface to manage your API queries. Below is a detailed guide on how to utilise the various features available on this page.

PreviousAPI QueriesNextAPI Queries Modal View

Last updated 7 months ago

Create Button:

  • Positioned at the top right corner of the page. It is a blue button labeled "+ Create", which opens a modal interface for creating new API queries.

Table View:

  • Column Headers:

    • Entity: Specifies the entity to which each API query is related.

    • Type: Indicates the type of API endpoint, here labeled as "Conduit V7".

    • Name: Displays the descriptive names given to the API queries.

    • URL: Shows the endpoint URL for each API query.

    • Actions: Contains action buttons for managing each API query (Copy, Edit, Delete).

  • Rows:

    • Each row represents a different API query and contains details under each column header.

    • The URLs include placeholders like <YOUR_TOKEN> and siteid, indicating where user-specific data will be inserted.

Action Buttons:

Located on the right side of each row under the Actions column.

  • Copy Icon: For copying the API URL to the clipboard, inserting the current user's token.

  • Cog Icon: For editing the API query, opening a modal interface for modifications.

  • Trash Icon: For deleting the API query.

Top Right Icons:

  • Column Settings Icon: Allows users to customize which columns are displayed in the table.

  • Maximize Table Icon: Enlarges the table to fill the entire window, reducing clutter.

  • Mobile/Tablet Handling Icon: Optimizes the table for better viewing on mobile devices and tablets.

  • Download Icon: Provides options to export the table data in formats like Excel, CSV, and PDF.

Pagination Information:

  • Located at the bottom right of the table, it shows the current page number and the total number of entries, along with navigation controls to move between pages.

Step-by-Step Guide

Filtering Queries:

  • Go to the filter field at the top left of the table.

  • Start typing the name or any keyword related to the API query you are looking for.

  • The table will dynamically update to show results matching your input.

Creating a New Query:

  • Click the Create button at the top right of the page.

  • Fill in the required details in the modal that appears, such as the endpoint, parameters, and any filters.

  • Save the query for future use.

Editing an Existing Query:

  • Locate the query you want to edit in the table.

  • Click the cog icon in the Actions column.

  • Make the necessary changes in the modal interface that appears and save your changes.

Copying an API URL:

  • Find the query whose URL you need.

  • Click the copy icon in the Actions column.

  • The URL, complete with your user token, will be copied to your clipboard.

Deleting a Query:

  • Identify the query you wish to delete.

  • Click the trash icon in the Actions column.

  • Confirm the deletion when prompted.

Exporting Table Data:

  • Click the download icon at the top right of the table.

  • Choose your preferred format (Excel, CSV, or PDF) and follow the prompts to save the file to your device.

By following these instructions, you can efficiently manage your API queries using the AlphaX API Endpoints tool.