Skip to main content

Submit a new query

POST 
/query

Submit a new read-only query request to retrieve ChF measurements (level two)* or Gardin Indices (level three) data for your tenancy.

Results are limited to a possible time range of current time (UTC) minus 365 days to current time (UTC) minus MAX(n, 1) hours, where n is adjustable depending on your license plan. It is not possible to retrieve data produced within the last hour using this API.

The Query API is asynchronous - no results are returned in the response of this endpoint. To retrieve query results, see: GET /query/:queryId/result/download endpoint documentation.

* Available on specific license plans only.

Required scope(s): [data.chf:query, data.indices:query]

Request​

Body

required
    type stringrequired

    Possible values: [chf, indices]

    The type of data to be queried - ChF measurements (chf) or Gardin Indices (indices).

    filters object

    Additional optional filters for refining your query.

    from date-time

    RFC 3339-compatible UTC timestamp specifiying the start of the time period to query. If not specified, defaults to current time UTC minus 25 hours. Values older than current time (UTC) minus 365 days will be clamped to this limit.

    to date-time

    RFC 3339-compatible UTC timestamp specifiying the end of the time period to query. If not specified, defaults to zero minutes (:00) past the hour calculated as current time UTC minus 24 hours. Values more recent than zero minutes (:00) past the hour calculated as current time UTC minus 24 hours will be clamped to this limit.

    sensors string[]

    List of sensor IDs to query for. If not specified, defaults to all sensors belonging to your tenancy.

    controlAreas string[]

    List of control area names to query for. If not specified, defaults to all control areas under your tenancy.

    indexNames string[]

    Possible values: [HEALTH, EFFICIENCY, PRODUCTIVITY, PEI]

    List of Gardin index names to query for. If not specified, defaults to all indices available to your tenancy. This filter is only valid when type is set to indices, otherwise an error will be raised.

      

    Possible values are as follows:

    1. HEALTH: Shows Fv/Fm during plant night time, and is a measure of the plant's potential for energy conversion. Higher values indicate a stronger plant that can grow rapidly.
    2. EFFICIENCY: Quantum yield or øPSII - the ratio of light photons converted for photosynthesis, impacted by light intensity and plant stress. A measure of photosynthetic efficiency which is the fraction of absorbed light used for photochemistry. Under the same lighting conditions, higher values are positively correlated with yield potential.
    3. PRODUCTIVITY†: Provides a relative indication of the amount of photosynthetic activity occurring. Under typical growing conditions, values correlate with rate of growth, and ultimately yield.
    4. PEI†: Plant energy balance indicates whether the plant has too much or too little light. A value of zero indicates an ideal balance of light. Typically a range of +/-25 indicates a nominal balance range.

    † Available as a limited beta at this time.

    selectColumns object

    This object defines a filtering mechanism for selecting which columns to include or exclude when submitting a query. Exactly one of include or exclude properties must be present. If not specified, defaults to all columns available to your tenancy.

      

    Possible values when type is set to chf are as follows:

    1. measurementId: The unique identifier for the measurement.
    2. timestamp: The timestamp (UTC) of the record.
    3. deviceId: The ID of the sensor that performed the measurement.
    4. jobId: The ID of the growth job associated with the measurement.
    5. f0: F0 (Minimum Fluorescence) - The fluorescence yield when all PSII reaction centers are open, measured under very low light conditions to avoid photochemical activity.
    6. fm: FM (Maximum Fluorescence) - The maximum fluorescence yield when all PSII reaction centers are closed, typically measured under a saturating pulse of light.
    7. fv: FV (Variable Fluorescence) - The difference between FM and F0, representing the variable portion of fluorescence that is directly related to the maximum quantum efficiency of PSII photochemistry.
    8. qe: QE (Quantum Efficiency of PSII) - Sometimes referred to as ΦPSII, represents the efficiency of energy conversion in PSII under light-adapted conditions.
    9. fv_fm: FV/FM (Maximum Quantum Yield of PSII) - The ratio of variable to maximum fluorescence, indicating the maximum potential quantum efficiency of PSII in a dark-adapted state.
    10. f0x: F0' (F0 Prime) - The minimal fluorescence yield in light-adapted states, when all PSII reaction centers are open but adapted to ambient light conditions.
    11. fvx_fmx: FV'/FM' (FV Prime over FM Prime) - The efficiency of energy conversion in PSII under light-adapted conditions, reflecting the quantum yield of PSII photochemistry in light.
    12. qp: QP (Photochemical Quenching) - A parameter reflecting the proportion of open PSII reaction centers that can perform photochemistry.
    13. f0x_f0: F0'/F0 (F0 Prime over F0) - The ratio of minimal fluorescence in light-adapted conditions to that in dark-adapted conditions, indicating changes in energy transfer efficiency.
    14. fqx_fmx: FQ'/FM' (FQ Prime over FM Prime) - Reflects the quantum yield of photochemical energy conversion in PSII under light-adapted conditions. It is analogous to FV'/FM' but emphasizes the difference between light-adapted FM' and the actual fluorescence yield under ambient light.
    15. npq: NPQ (Non-Photochemical Quenching) - A mechanism that dissipates excess light energy as heat to protect the plant from photodamage, measured as the decrease in fluorescence yield under high light conditions.
    16. ql: QL (Lake Model Quenching) - Represents the distribution of excitation energy between open and closed PSII reaction centers, based on the lake model of photosystem II.
    17. qcn: QCN - A specific parameter related to non-photochemical quenching processes.
    18. fv_f0: FV/F0 (FV over F0) - The ratio of variable fluorescence to minimum fluorescence, providing an indication of the potential efficiency of PSII in converting light energy to chemical energy in a dark-adapted state.

      

    Possible values when type is set to indices are as follows:

    1. timestamp: The timestamp (UTC) of the record.
    2. deviceId: The ID of the sensor that performed the measurements from which the index value has been calculated.
    3. jobId: The ID of the growth job associated with the index value.
    4. indexName: The name of the Gardin index. Please refer to indexName request parameter in the POST /query endpoint documentation for details.
    5. indexValue: The value of the named index for the specified timestamp, growth job and device.
    oneOf
    include string[]required

    An array of strings containing the names of columns to include in the response.

    jobId string

    If specified, filters results based on the provided job ID.

    isDaytime boolean

    Applicable only when type is set to chf. This filter is ignored in other situations.

    If true, only results captured during plant daytime will be returned. If false, only results captured during plant night time will be returned. If missing, filter not applied.

Responses​

Accepted - Query has been successfully submitted for execution.

Schema
    queryId string

    Unique identifier for the submitted query.

    status string

    Provides status of submission - value will always be set to SUBMITTED.

Loading...