API Reference
WS detail/list (area_context)

Area taxonomy

Configuration metadata for the areas defined on your locations — enumerate available zones before querying.

Returns configuration metadata for the areas defined inside your locations — what each area is called, which taxonomy it sits under, what type it is. Use it to enumerate available areas before issuing area/* metric queries.

Returned via detail/list with returnEntityType: "area_context".

Body parameters

Standard detail request envelope. Set returnEntityType: "area_context". Filter fields are optional.

Optional filter fields

FieldTypeDescription
areaTypestringRestrict to a specific area type ("taxonomy" or "location-dwell")
taxonomystringRestrict to a zone path

Example request

{
  "action": "detail",
  "data": {
    "id": "req-ac-001",
    "route": "detail/list",
    "body": {
      "returnEntityType": "area_context",
      "entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
      "entityType": "location"
    }
  }
}

Example response

req-ac-001|0|0|[
  {
    "organisation_id": "64a1b2c3d4e5f6a7b8c9d0e2",
    "location_id": "64a1b2c3d4e5f6a7b8c9d0e3",
    "recording_id": "64a1b2c3d4e5f6a7b8c9d0e4",
    "area_id": "64a1b2c3d4e5f6a7b8c9d0fb",
    "area_type": "taxonomy",
    "taxonomy": "Service:Checkout"
  },
  {
    "organisation_id": "64a1b2c3d4e5f6a7b8c9d0e2",
    "location_id": "64a1b2c3d4e5f6a7b8c9d0e3",
    "recording_id": "64a1b2c3d4e5f6a7b8c9d0e5",
    "area_id": "64a1b2c3d4e5f6a7b8c9d0fc",
    "area_type": "taxonomy",
    "taxonomy": "Service:Fitting Rooms"
  }
]

area_type is one of taxonomy (named zone) or location-dwell (whole location pseudo-area).