Versions Compared

Key

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

Request Body

All the fields in dataqueries request body are similar to EcoPlots API search queries except for "exact_match" field under the "query". To review the more general information about constructing search queries, see EcoPlots API - creating search queries.

The request body for all the Dataqueries endpoint has endpoints contains a "query" field under which values of facets for filtering can be plugged in. This field allows users to specify what values should be used for filtering the facets. While the "query" field is common for all the endpoints, the
/species/observations dataqueries endpoint has two more fields namely, used for the pagination of large responses ("page_number" and "page_size").

All the fields in request body are similar to EcoPlots API search queries except for "exact_match" field under the "query". The following are all the subfields under "query" field in that can be used in the request body.

  • "dataset": ["dataset-url-1", "dataset-url-2", ...]

  • "date_from": "2020-01-01"

  • "date_to": "2023-05-09"

  • "exact_match": false

  • "feature_type": ["feature-type-url-1", "feature-type-url-2", ...]

  • "observed_property": ["observed-property-url-1", ...]

  • "region": ["region-url-1", "region-url-2", ...]

  • "site_id": ["site-id-url-1", "site-id-url-2", ...]

  • "spatial": { }

...

Panel
panelIconId1f5d2
panelIcon:notepad_spiral:
panelIconText🗒️
bgColor#E6FCFF

Please note that for endpoints other than /species/observations, there is no need to include
"page_number" and "page_size" as they are NOT required.

For further information on pagination, please refer to EcoPlots API- paginating results.