Kaax
HomeSign In
Referencia

Analyses

The already-processed results: counting, replanting and segmentation, with their area and density metrics. This is what an integration consumes to report.

GET/api/v2/analyses

The account's analyses, filterable and paginated.

Parámetros

namestringoptional

Lot name. Partial, case-insensitive match.

tagstringoptional

Lot tag — useful for separating farms or seasons.

typestringoptionalcounting · replanting · path

Analysis type.

startstringoptional

Range start: ISO date (2026-03-01), bare year (2026) or Unix milliseconds.

endstringoptional

Range end, in the same formats as start.

pageintegeroptionaldefault 1

Page number, starting at 1.

limitintegeroptionaldefault 20 · max 100

Results per page.

Response

json
{
  "total": 42,
  "page": 1,
  "limit": 20,
  "data": [
    {
      "_id": "675a93c456a2f093c8c4651f",
      "imageSetId": "64fa12b3e4c1a20012d3ef01",
      "name": "Banano Álamos",
      "analysisType": "counting",
      "analysis": {
        "totalAreaHa": 6.279,
        "totalCounts": 12480,
        "density": 1987.4
      },
      "kml": "<kml>…</kml>",
      "createdAt": "2026-05-14T18:22:34.159Z"
    }
  ]
}

A tener en cuenta

  • Filters INTERSECT. `name=alfa&type=replanting` returns only what satisfies both.
  • Sorted by `createdAt` descending, so paginating is stable.
  • A sub-user's apiKey sees only the analyses of the lots it created and of the fields assigned to it — what its dashboard shows. The owner's sees the whole account.
  • Replaces `POST /api/v0/analyses`, which still works but is deprecated.
GET/api/v2/analyses/{id}

One analysis by its id, in full and in the same shape as a list item.

Parámetros

idstringrequiredpath

The analysis `_id`, exactly as the list returns it.

Response

json
{
  "_id": "675a93c456a2f093c8c4651f",
  "imageSetId": "64fa12b3e4c1a20012d3ef01",
  "name": "Banano Álamos",
  "analysisType": "counting",
  "analysis": {
    "totalAreaHa": 6.279,
    "totalCounts": 12480,
    "density": 1987.4
  },
  "vegetationIndices": [
    { "indexType": "ndvi", "status": "generated", "globalMedian": 0.62 }
  ],
  "kml": "<kml>…</kml>",
  "createdAt": "2026-05-14T18:22:34.159Z"
}

A tener en cuenta

  • If you already have the id, use this instead of walking the list: it does not depend on which page the analysis landed on.
  • An id that does not exist, or that the apiKey cannot see, answers 404 `ANALYSIS_NOT_FOUND`. Never 403: the answer does not reveal whether it exists on another account.
  • A malformed id answers 400 `INVALID_ID`.