Getting Started

Generate an Analysis

Once you have a registered polygon, you can request satellite analyses. Each analysis processes satellite imagery for your field over a specified date range.

How It Works

Analysis generation is a mutation that submits a processing request to the Agdir pipeline. The API acknowledges your request immediately, but the actual analysis runs asynchronously. You will need to monitor the request to know when results are ready.

Common Parameters

Most analysis mutations share the same three parameters:

polygonId REQUIRED

The unique polygon identifier returned when you registered your field.

startDate REQUIRED

Start of the analysis period in YYYY-MM-DD format.

endDate REQUIRED

End of the analysis period in YYYY-MM-DD format.

Plant Health Example

The processPlantHealth() mutation generates an NDVI-based plant health analysis:

GraphQL Mutation

mutation { processPlantHealth( polygonId: "abc123-def456-ghi789" startDate: "2025-06-01" endDate: "2025-08-31" ) { Status Message Result { requestId } } }

Water Stress Example

The processWaterStress() mutation generates an NDWI-based water stress analysis:

GraphQL Mutation

mutation { processWaterStress( polygonId: "abc123-def456-ghi789" startDate: "2025-06-01" endDate: "2025-08-31" ) { Status Message Result { requestId } } }

Understanding the Response

JSON Response

{ "data": { "processPlantHealth": { "Status": "OK", "Message": "Request submitted successfully", "Result": { "requestId": "req-xyz-123" } } } }

Field	Description
`Status`	Indicates whether the API accepted your request. An "OK" status means the request was received — it does not mean the analysis is complete.
`Message`	A human-readable message describing the result of the API call.
`Result.requestId`	A unique identifier for tracking this specific analysis request through the processing pipeline.

Note: The Status field reflects whether the API successfully received your request. It does not indicate whether the analysis itself has completed. Use the monitoring queries to check actual progress.

Available Analyses

The API supports many types of analyses beyond plant health and water stress. See the Usage section for the full list of available services.