Querying the live database
Pieter Huybrechts
2025-08-12
query_obs.Rmd
get_vespadb_obs()
supports a number of query parameters
that allow you to get a subset of the observations in the database.
This is an overview of the parameters that are allowed:
name | in | description | required | type | format | default | items | example | maxItems | minItems |
---|---|---|---|---|---|---|---|---|---|---|
municipality_id | query | municipality_id | FALSE | string | NA | NA | NA | NULL | NA | NA |
province_id | query | province_id | FALSE | string | NA | NA | NA | NULL | NA | NA |
min_created_datetime | query | min_created_datetime | FALSE | string | NA | NA | NA | NULL | NA | NA |
max_created_datetime | query | max_created_datetime | FALSE | string | NA | NA | NA | NULL | NA | NA |
min_modified_datetime | query | min_modified_datetime | FALSE | string | NA | NA | NA | NULL | NA | NA |
max_modified_datetime | query | max_modified_datetime | FALSE | string | NA | NA | NA | NULL | NA | NA |
min_observation_datetime | query | min_observation_datetime | FALSE | string | NA | NA | NA | NULL | NA | NA |
max_observation_datetime | query | max_observation_datetime | FALSE | string | NA | NA | NA | NULL | NA | NA |
anb | query | anb | FALSE | string | NA | NA | NA | NULL | NA | NA |
nest_type | query | nest_type | FALSE | string | NA | NA | NA | NULL | NA | NA |
visible | query | visible | FALSE | string | NA | NA | NA | NULL | NA | NA |
nest_status | query | nest_status | FALSE | string | NA | NA | NA | NULL | NA | NA |
ordering | query | Which field to use when ordering the results. | FALSE | string | NA | NA | NA | NULL | NA | NA |
dist | query | Represents Distance in Distance to point filter. Default value is used only if point is passed. | FALSE | number | float | 1000 | NA | NULL | NA | NA |
point | query | Point represented in x,y format. Represents point in Distance to point filter | FALSE | array | NA | NA | float | 0, 10 | 2 | 2 |
cursor | query | The pagination cursor value. | FALSE | string | NA | NA | NA | NULL | NA | NA |