API Reference
WS detail/list (thumbnails-with-statelems)

Thumbnails with overlays

Camera thumbnails with overlaid stat-element coordinates (lines, areas).

Returns camera thumbnails with the stat-element coordinates (lines, areas) overlaid on top — useful for debugging zone configuration or building admin UIs that visualise where lines and areas sit on the frame. Returned via detail/list with returnEntityType: "thumbnails-with-statelems".

For plain thumbnails without overlays, use Thumbnails.

Body parameters

Standard detail request envelope. Set returnEntityType: "thumbnails-with-statelems". Filter fields are optional.

Optional filter fields

FieldTypeDescription
startstring (ISO 8601)Restrict to a time range
endstring (ISO 8601)Restrict to a time range
lineTypestringRestrict to a line type
areaTypestringRestrict to an area type
taxonomystringRestrict to a zone path

Example request

{
  "action": "detail",
  "data": {
    "id": "req-thso-001",
    "route": "detail/list",
    "body": {
      "returnEntityType": "thumbnails-with-statelems",
      "entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
      "entityType": "location",
      "filter": {
        "areaType": "taxonomy",
        "taxonomy": "Service:Checkout"
      }
    }
  }
}

Example response

req-thso-001|0|0|[
  {
    "recording_id": "64a1b2c3d4e5f6a7b8c9d0e4",
    "location_id": "64a1b2c3d4e5f6a7b8c9d0e3",
    "url": "https://thumbnailer.auravisionlabs.com/<signed-key>",
    "statElems": {
      "areaStatElems": [
        {
          "area_id": "64a1b2c3d4e5f6a7b8c9d0fb",
          "area_type": "taxonomy",
          "taxonomy": "Service:Checkout",
          "polygon": [[120, 90], [420, 90], [420, 310], [120, 310]]
        }
      ],
      "lineStatElems": []
    },
    "contexts": {
      "lineContexts": [],
      "areaContexts": [
        {
          "area_id": "64a1b2c3d4e5f6a7b8c9d0fb",
          "area_type": "taxonomy",
          "taxonomy": "Service:Checkout"
        }
      ]
    }
  }
]