API Reference
WS detail/list (line_context)

Line taxonomy

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

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

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

Body parameters

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

Optional filter fields

FieldTypeDescription
lineTypestringRestrict to a specific line type
taxonomystringRestrict to a zone path

Example request

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

Example response

req-lc-001|0|0|[
  {
    "organisation_id": "64a1b2c3d4e5f6a7b8c9d0e2",
    "location_id": "64a1b2c3d4e5f6a7b8c9d0e3",
    "recording_id": "64a1b2c3d4e5f6a7b8c9d0e4",
    "line_id": "64a1b2c3d4e5f6a7b8c9d0fa",
    "line_type": "within-location-entry",
    "taxonomy": "Products:Clothing:Shoes",
    "direction": "forward",
    "derived_from_in_out": false
  }
]

line_type is one of location-entry, within-location-entry, within-location-movement, within-location-pass-by. direction indicates which side counts as entry. derived_from_in_out is true for lines synthesised from in/out pair definitions.