Kaax
HomeSign In
Referencia

Analyses

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

GET/api/v2/analyses

The account's analyses, filterable and paginated.

Parámetros

namestringoptional

Lot name. Partial 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.
  • Replaces `POST /api/v0/analyses`, which still works but is deprecated.