API Queries Modal View
The Create/Edit API Endpoint modal is a comprehensive interface that allows users to configure API queries with precision.
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.
Type:
Label: "Type *" indicates a required field.
Dropdown Menu: Default set to "Conduit V7", users can select from different output formats depending on their access levels and account. See developer docs for more information on output formats.
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.
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.
Last updated