Brapi Find Observations
brapi_find_observationsPull observation records filtered by study, germplasm, variable, season, or observation unit. When the upstream total exceeds loadLimit, the full result set is materialized as a dataframe — query it with brapi_dataframe_query (SQL).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Connection alias registered via brapi_connect. Omit to read the connection registered under alias `default` — i.e. a prior brapi_connect call that did not specify an alias. Calls that used a non-default alias must pass that same alias here. | |
| trials | No | Filter by trialDbIds. | |
| seasons | No | Filter by seasonDbIds (e.g. "2022"). | |
| studies | No | Filter by studyDbIds. | |
| programs | No | Filter by programDbIds. | |
| germplasm | No | Filter by germplasmDbIds. | |
| loadLimit | No | Cap on rows returned inline. Omit for the deployment default. Rows beyond the cap land in a dataframe; query with brapi_dataframe_query (SQL) instead of paging row-by-row. | |
| variables | No | Filter by observationVariableDbIds. | |
| timestampTo | No | ISO 8601 end of the observation-time window. | |
| extraFilters | No | Extra BrAPI filters forwarded verbatim. Valid keys vary by endpoint; brapi_describe_filters enumerates them. Named params on this tool take precedence on conflict. | |
| observations | No | Filter by observationDbIds. | |
| timestampFrom | No | ISO 8601 start of the observation-time window. | |
| observationUnits | No | Filter by observationUnitDbIds. | |
| observationLevels | No | Observation unit level (plot, plant, field, etc.). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | No | Alias of the registered BrAPI connection the call used. | |
| error | No | Present when the call failed. Absent on success. | |
| notice | No | Guidance when no rows were returned — how to broaden filters or retry. | |
| hasMore | No | True when more rows exist beyond the returned set. | |
| results | No | Observation rows returned in-context (up to loadLimit). | |
| warnings | No | Advisory messages (filter overrides, partial data, capability gaps). | |
| dataframe | No | Dataframe handle when the full result set was materialized as a dataframe. Query it with brapi_dataframe_query (SQL). | |
| totalCount | No | Total rows reported by the server. | |
| distributions | No | Value frequency per field across the full result set. | |
| returnedCount | No | Length of results[]. | |
| appliedFilters | No | The final filter map sent to the server (named + extraFilters). | |
| refinementHint | No | Suggested next-step query refinement when the result set is large. |