How-To Guide: Using Feeds to Set Up API Endpoints in AlphaX

Introduction:

The Feeds feature in AlphaX is a powerful tool designed to streamline and optimise the creation of API endpoints to accelerate data extraction and interpretation. In this article, we will explore the unique benefits of this feature and its significance for various professional domains, such as data scientists, business intelligence teams, and integrators.

Core Benefits:

Easy Creation of JSON API Endpoints:

With just a few clicks, users can create and save JSON API endpoints. This simplifies the process of data extraction and communication between different software components, eliminating the complexities associated with creating endpoints manually.

Flexible Data Aggregation and Grouping:

The Feeds feature allows users to aggregate and group their data into specific segments, offering a tailored perspective on the data.
Instead of sifting through vast amounts of raw data, users can focus on specific data clusters that are relevant to their objectives.

Why It Matters (Examples):

For Data Scientists:

• Predictive Maintenance: By using feeds to pull specific data about machinery health, wear and tear, and usage cycles, data scientists can predict when a machine is likely to fail or require maintenance, reducing downtime.
• Example: A data scientist working in a manufacturing firm can set up feeds to extract hourly temperature, vibration, and noise levels of critical machinery. Using this data, they can predict potential breakdowns and schedule preventive maintenance.

For Business Intelligence Teams:

• Asset Lifespan Analysis: By aggregating data on asset usage, the BI teams can analyze the remaining lifespan of an asset and plan for its eventual replacement, ensuring continuity in operations.
• Example: A transportation company’s BI team can set up a feed that pulls monthly mileage and wear-tear data of their fleet of trucks, allowing them to project when a particular vehicle might need to be retired and replaced.

For Integrators:

• Asset Location Tracking and Reporting: Integrators can employ feeds to gather location and movement data from assets fitted with GPS or IoT sensors, ensuring accurate asset tracking in real-time across various systems.
• Example: For a construction company that utilizes heavy machinery across multiple sites, integrators can use feeds to extract real-time location data of these assets. By integrating this data with project management tools, it allows project managers to efficiently allocate and relocate machinery based on project needs and timelines.

Video:

Step-by-Step Instructions:

1. Navigate to the Feeds Section:

– Upon logging into AlphaX, locate and click on the “Feeds” section.

2. Creating a New Endpoint:

– Click on the “Create a new endpoint” button.
– A modal will appear with fields for you to fill out.

3. Setting up the Endpoint Modal:

– Name: Enter a name for your feed. This is for your reference.
– Endpoint Format: Choose your desired format. For specific details on each format, refer to our support articles.
– Entity: Determine the level of the entity hierarchy from which data will be aggregated. This includes all data from the chosen entity and any entities below it in the hierarchy.
– Time Range: Choose from preset durations like last 1 hour, 24 hours, 7 days, 30 days, or opt for custom ranges.

Note: Custom ranges are fixed in time.

– Limit: Specify the total number of records you want to be returned.
– Timezone: Select a timezone to normalise all data outputs.
– Group By: Use this to aggregate and group data outputs. Leaving it as “none” will return all records.
– Pre-Aggregate: This powerful feature allows up to 4 stages of aggregation for the data feed. For an in-depth guide on pre-aggregations, visit our [knowledge base article](https://minnovation.com.au/knowledge-base/guide-to-multi-stage-aggregations-time-series-data-api-endpoint-conduit-v7/).

4. Save the Endpoint:

– Once you’ve filled out all the fields, click the “Save” button.
– Your new endpoint will now appear in the table.

Copy the Endpoint URL:

– Find your new endpoint in the table.
– Click on the “Copy” button next to it to copy the endpoint URL, which you can then use elsewhere.

Editing the Endpoint:

– Click the “Edit” button next to your endpoint in the table.
– Make your changes using the modal as explained above, then save.

Note: The URL will be updated after editing.

Deleting the Endpoint:

– If you need to delete an endpoint, click the “Delete” button associated with it.
– Confirm the deletion. **Caution**: Once deleted, the endpoint is permanently removed from the list and the database, and it cannot be retrieved.

Conclusion:

With these steps, you should now be proficient in creating, managing, and utilising endpoints in AlphaX. Remember, the data you gather is only as good as the tools and methods you use to extract and interpret it. Make use of the advanced features AlphaX offers to ensure your data serves your needs effectively.

Need further assistance?

Our support team is always available to help. Feel free to reach out with any questions or concerns regarding the AlphaX platform and its functionalities.