Skip to main content

Download query result

GET 

/query/:queryId/result/download

Download the results of a completed query as single CSV file.

This endpoint returns a presigned URL that allows time-limited access to the CSV results which users should follow to download the file.

Results for a query (identified by :queryId) can only be accessed by the user who originally submitted it.

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

The column headers of generated CSV files will adhere to the following specification:

  • Query results: All headers that represent columns from the query results will have the data__ prefix, followed by the column name. For example, data__indexValue, data__timestamp etc.

  • Additional metadata:

    • query_statement_name: The ID of the source query submitted via the query API.
    • record_no: A unique ID for each record.

An example of a generated CSV file would is as follows:

data__timestamp, data__timestampIso, data__deviceId, data__jobId, data__indexName, data__indexValue, query_statement_name, record_no
2024-05-03 21:00:00, 2024-05-03T21:00:00Z, G111001, JOB_V1_PLANT23, HEALTH, 84.2, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 0
2024-05-03 21:00:00, 2024-05-03T21:00:00Z, G111001, JOB_V1_PLANT23, PRODUCTIVTY, 88.1, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 1
2024-05-03 21:00:00, 2024-05-03T21:00:00Z, G111001, JOB_V1_PLANT23, PEI, 14, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 2
2024-05-03 22:00:00, 2024-05-03T22:00:00Z, G111002, JOB_V1_PLANT23, HEALTH, 85.8, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 3
2024-05-03 22:00:00, 2024-05-03T22:00:00Z, G111001, JOB_V1_PLANT23, PEI, 13.1, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 4
2024-05-03 23:00:00, 2024-05-03T23:00:00Z, G111002, JOB_V1_PLANT23, PRODUCTIVTY, 89.2, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 5

...

2024-05-04 13:00:00, 2024-05-04T13:00:00Z, G111001, JOB_V1_PLANT23, EFFICIENCY, 56.1, dbcfbdf1-133a-46ef-9704-31eb17446e7c, 21405

Response schemas

Chlorophyll Fluorescence (ChF) result set

NameDescriptionTypeExample
timestampThe timestamp (UTC) of the record.Timestamp2023-08-15 10:00:00
timestampIsoThe timestamp (UTC) of the record in ISO 8601 format.Timestamp2023-08-15T10:00:00Z
measurementIdThe unique identifier for the measurement.UUID (V4)39FE5FA1-D477-43B2-9E2A-6044E0C656F5
deviceIdThe ID of the sensor that performed the measurement.StringG111001
jobIdThe ID of the growth job associated with the measurement.StringJOB_V1_PLANT23
isDaytimeTrue if measurement was captured during plant daytime, otherwise False.Boolean (t for True, f for False)t
f0F0 (Minimum Fluorescence) - The fluorescence yield when all PSII reaction centers are open.Float19.41
fmFM (Maximum Fluorescence) - The maximum fluorescence yield when all PSII reaction centers are closed.Float47.13
fvFV (Variable Fluorescence) - The difference between FM and F0.Float27.72
qeQE (Quantum Efficiency of PSII) - Represents the efficiency of energy conversion in PSII under light.Float0.59
fv_fmFV/FM (Maximum Quantum Yield of PSII) - Ratio of variable to maximum fluorescence in a dark-adapted state.Float0.59
f0xF0' (F0 Prime) - The minimal fluorescence yield in light-adapted states.Float18.33
fvx_fmxFV'/FM' (FV Prime over FM Prime) - Efficiency of energy conversion in PSII under light-adapted conditions.Float0.61
qpQP (Photochemical Quenching) - Reflects the proportion of open PSII reaction centers.Float0.96
f0x_f0F0'/F0 (F0 Prime over F0) - Ratio of minimal fluorescence in light-adapted vs dark-adapted conditions.Float0.94
fqx_fmxFQ'/FM' (FQ Prime over FM Prime) - Reflects the quantum yield of photochemical energy conversion in PSII.Float0.59
npqNPQ (Non-Photochemical Quenching) - Mechanism that dissipates excess light energy as heat.Float0.79
qlQL (Lake Model Quenching) - Represents the distribution of excitation energy between open and closed PSII.Float0.91
qcnQCN - A specific parameter related to non-photochemical quenching processes.Float0.44
fv_f0FV/F0 (FV over F0) - Ratio of variable fluorescence to minimum fluorescence in a dark-adapted state.Float2.48
query_statement_nameThe ID of the source query submitted via the query API.UUID (V4)7b4f787b-2c78-40b3-8f5c-2eebff04f208
record_noA unique ID for each result set record.Integer145

Indices result set

NameDescriptionTypeExample
timestampThe timestamp (UTC) of the record.Timestamp2023-08-15 10:00:00
timestampIsoThe timestamp (UTC) of the record in ISO 8601 format.Timestamp2023-08-15T10:00:00Z
deviceIdThe ID of the sensor that performed the measurements from which the index value has been calculated.StringG111001
jobIdThe ID of the growth job associated with the index value.StringJOB_V1_PLANT23
indexNameThe name of the Gardin index, which can be one of the following:

HEALTH: Shows Fv/Fm during plant night time, indicating the plant's energy conversion potential. Higher values indicate stronger growth.

EFFICIENCY: Quantum yield (øPSII), showing the fraction of absorbed light used for photosynthesis. Higher values correlate with yield potential.

PRODUCTIVITY†: Indicates photosynthetic activity, correlating with plant growth and yield.

PEI†: Plant energy balance indicating the plant's light balance, with zero being ideal and +/-25 being the nominal range.

DLI: Daily light integral (mol/m²/day) measuring the total amount of photosynthetically active radiation (PAR) that a plant receives over the course of a day.

DPI: Daily photosynthesis integral (mol/m²/day) measuring the total amount of daily light assimilation by the plant.

PPFD: Measures the Photosynthetic Photon Flux Density (PPFD) at the leaf level.
StringHEALTH
indexValueThe value of the named index for the specified timestamp, growth job, and device.Float72.5
isFilledTrue if index value was produced via automatic interpolation, otherwise False.BooleanTRUE
query_statement_nameThe ID of the source query submitted via the query API.UUID (V4)7b4f787b-2c78-40b3-8f5c-2eebff04f208
record_noA unique ID for each result set record.Integer145

† Available on selected license plans.

Request

Path Parameters

    queryId stringrequired

    Unique identifier of the query.

    Example: 4DDC21D9-E30C-458A-80E2-642CA3238541

Responses

Successful retrieval of query results CSV file URI.

Schema
    uri string

    The presigned URI of the CSV file.

Loading...