Kaax
InícioEntrar
Referencia

Análises

Os resultados já processados: contagem, replantio e segmentação, com métricas de área e densidade. É o que uma integração consome para relatar.

GET/api/v2/analyses

As análises da conta, filtráveis e paginadas.

Parámetros

namestringopcional

Nome do lote. Correspondência parcial, sem diferenciar maiúsculas.

tagstringopcional

Etiqueta do lote — útil para separar fazendas ou safras.

typestringopcionalcounting · replanting · path

Tipo de análise.

startstringopcional

Início do intervalo: data ISO (2026-03-01), ano solto (2026) ou milissegundos Unix.

endstringopcional

Fim do intervalo, nos mesmos formatos de start.

pageintegeropcionaldefault 1

Página, começando em 1.

limitintegeropcionaldefault 20 · max 100

Resultados por página.

Resposta

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

  • Os filtros se INTERSECTAM. `name=alfa&type=replanting` devolve apenas o que cumpre ambos.
  • Ordenado por `createdAt` descendente, então paginar é estável.
  • A apiKey de um sub-usuário vê apenas as análises dos lotes que criou e dos campos atribuídos a ele — o mesmo que o seu dashboard. A do dono vê a conta inteira.
  • Substitui `POST /api/v0/analyses`, que continua funcionando mas está deprecado.
GET/api/v2/analyses/{id}

Uma análise pelo seu id, completa e com a mesma forma de um item da lista.

Parámetros

idstringobrigatóriopath

O `_id` da análise, exatamente como a lista o devolve.

Resposta

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

  • Se você já tem o id, use este endpoint em vez de percorrer a lista: não depende de em qual página a análise ficou.
  • Um id que não existe, ou que a apiKey não pode ver, responde 404 `ANALYSIS_NOT_FOUND`. Nunca 403: a resposta não revela se existe em outra conta.
  • Um id malformado responde 400 `INVALID_ID`.