Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section will cover the EcoPlots API Dashboard (EcoPlots API Query Dashboard) and will run through examples of how to use the dashboard to extract and visualise data.

The API Dashboard is another way that users can query data stored within EcoPlots using an API. The dashboard provides a lightweight interface for EcoPlots APIs to query datasets hosted on the EcoPlots Platform. The interface offers standard pre-defined query patterns to retrieve data from multiple data sources based on simple selection criteria. Users can use this dashboard to construct queries and get a code snippet to access data in any programming language. The interface provides sample data for a constructed query. Hence, users must use generated code snippets to retrieve the complete dataset for any constructed query. Alternatively, users can use the EcoPlots search dashboard to perform more detailed search and download data.

To navigate to the dashboard, go to the EcoPlots home page (https://ecoplots.tern.org.au/) and click on the (blue star) tab in the menu bar and select the API Query Dashboard.

The API dashboard can be found here https://ecoplots.tern.org.au/discovery

User can query For more information and detailed instructions on using the API Query Dashboard, you can select the (blue star) button, which will generate the following screen:

Image Added

Now we can go through the steps of selecting and extracting data. User can query the data by either “Dataset” or “Region” . The API dashboard can be found here https://ecoplots.tern.org.au/discovery (as seen below).

...

Once a selection has been made, you can use additional search parameters: Datasource, Feature Type, Survey sites and Observable properties to narrow down the results.

Image Added

In the below example, we are using the “Dataset” query endpoint and have selected the TERN Ecosystem Processes datasource. For this basic example, we are interested in extracting all observable properties involving above-ground biomass, stem diameter, stem height and species' scientific names.

...

Once the search parameters have been selected, click on the (blue star) button and the following screen will be displayed.

...

Here we can either select the data format (either CSV or GeoJson) (blue star) . In this example, we have selected the CSV option. In the grey “search body” section, we can see the query results showing the respective URLs of the “dataset” and the observable properties (above-ground biomass, stem diameter, stem height and species' scientific names. To access the data,