Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Plot observations

Get all plot observations included in a user dataset

Retrieve a paginated and sorted collection of all plot observations associated with the specified user dataset (using its ds_code), or a subset thereof based on a specified search query.

get/user-datasets/{ds_code}/plot-observations

Path parameters

ds_codestring required

Query parameters

searchstring

Search term used for full-text record retrieval

status'any' | 'current'

Status criterion for returned plot observations:

  • any: Returns matching plot observations regardless of status
  • current: Only returns observations that haven't been replaced by a newer observation
detail'geo' | 'minimal' | 'full'

Level of detail for the response:

  • geo: Returns core location fields only
  • minimal: Returns basic fields only
  • full: Returns more fields
with_nestedboolean

Whether to include nested fields in the response

sort'default' | '+default' | '-default' | 'author_obs_code' | '+author_obs_code' | '-author_obs_code'

Sort order for results. Prefix with - for descending order or + for ascending order. Ascending order is the default if no prefix is provided.

Available sort fields:

  • default - Default sort order
  • author_obs_code - Sort by the author-provided plot observation code

Examples:

  • sort=author_obs_code - Sort by observation code ascending
  • sort=-author_obs_code - Sort by observation code descending
limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

bundlestring

If 'csv', return a zip archive of CSVs. When set, the limit parameter will default to 20000 (and higher values will be ignored), the detail parameter will be set to 'full', and the with_nested parameter will be set to false.

num_taxainteger

Number of taxa to return per plot observation. Sort order depends on detail level:

  • With detail=minimal: Descending order by max cover
  • With detail=full: Alphabetical order by plant name
num_commsinteger

Number of communities to return per plot observation, ordered by commclass_id

Response

Matching plot observation(s), with fields based on parameters:

  • detail=geo: Name, identifier, and lat/lon fields only
  • detail=minimal&with_nested=false: Basic fields only
  • detail=minimal&with_nested=true: Basic fields + nested array fields
  • detail=full&with_nested=false: Extended fields, no nested array fields
  • detail=full&with_nested=true: Extended fields + nested array fields
  • bundle=csv: ZIP archive containing related CSV files
OR
OR
OR
OR

Example response

{
  "count": 115000,
  "data": [
    {
      "ob_code": "ob.1",
      "author_obs_code": "YOSE.001",
      "latitude": 42.19,
      "longitude": -104.54
    }
  ]
}