Reports

A site's mapped inventory as GeoJSON: the same facts a PDF report shows, in a form a program can read.

get /sites/{siteId}/report Get a site's inventory report

gethttps://treeinventory.ai/api/v1/sites/{siteId}/report

Get a site's inventory report

A GeoJSON FeatureCollection of the site's mapped trees. Trees with no usable GPS fix are counted in excludedCount rather than dropped silently.

Scope: reports:read

Path parameters

Field	Type	Notes
siteIdrequired	uuid	The site's id.

Query parameters

Field	Type	Notes
species	string	Comma-separated species slugs. Omit for every species.

data

Field	Type	Notes
type	"FeatureCollection"
features	object[]
excludedCount	integer	Trees omitted because they carry no usable GPS fix.

Example response 200

{
  "success": true,
  "message": "Report retrieved",
  "data": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.58471,
            39.19124
          ]
        },
        "properties": {
          "treeNumber": 1,
          "commonName": "Northern Red Oak",
          "dbhInches": 22,
          "healthCondition": "fair"
        }
      }
    ],
    "excludedCount": 0
  }
}

Failures

401 Missing, malformed, revoked or expired credential. The WWW-Authenticate header names the scheme, which is ApiKey.
403 The key is valid but does not carry the scope this operation requires. The message names the scope, so you can ask for exactly the grant you need.
404 No such record in your organization. A record belonging to somebody else is indistinguishable from one that does not exist.
422 Validation failed. Every bad field is named, at once.
429 Rate limit exceeded.
500 Something failed on our side. Retry with the SAME Idempotency-Key; a 5xx is the one status where retrying is correct.