Line entries per visitor | Aura Vision API

Returns the number of entries across a named line divided by the number of location entrants over the same period — i.e. on average, how many times each visitor entered through this line. Useful for comparing zone engagement across locations or time periods with different overall traffic.

Body parameters

Field	Type	Required	Description
`start`	string (ISO 8601)	yes	Inclusive start timestamp with timezone
`end`	string (ISO 8601)	yes	Inclusive end timestamp with timezone
`entities`	string[]	yes	Array of location, organisation, or recording IDs (matching `entityType`)
`entityType`	`"location"` \| `"organisation"`	yes	Aggregation level
`taxonomy`	string[]	yes	Array of zone path strings, e.g. `["Products:Clothing:Shoes"]` — see how taxonomies work
`facets`	string[]	yes	What to include: `segments`, `summary`, `aggregates`, `thumbnails`, `thumbnails-with-statelems`
`aggregationPeriod`	string	yes	Time granularity — see aggregation period options
`breakdownByDimensions`	string[]	no	Split data by: `entity`, `taxonomy`, `age`, `gender`, `role`
`roles`	string[]	conditional	Required when `breakdownByDimensions` includes `role`
`genders`	string[]	conditional	Required when `breakdownByDimensions` includes `gender`
`ages`	string[]	conditional	Required when `breakdownByDimensions` includes `age`
`insideRecordingTimes`	boolean	no	`true` to restrict to opening hours only. Default `false`

Example request

{
  "action": "metric",
  "data": {
    "id": "req-cpe-001",
    "route": "internal/line-crossings-per-location-entrant",
    "body": {
      "start": "2024-04-01T00:00:00.000Z",
      "end": "2024-04-07T23:59:59.000Z",
      "entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
      "entityType": "location",
      "taxonomy": ["Products:Clothing:Shoes"],
      "facets": ["segments", "summary"],
      "aggregationPeriod": "day"
    }
  }
}

Example response

req-cpe-001|0|0|{
  "segments": [
    { "index": "2024-04-01T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "internal_line_crossings_per_location_entrant": 0.243 },
    { "index": "2024-04-02T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "internal_line_crossings_per_location_entrant": 0.261 }
  ],
  "summary": [
    { "location": "64a1b2c3d4e5f6a7b8c9d0e3", "internal_line_crossings_per_location_entrant": 0.241 }
  ],
  "meta": {
    "units": {
      "internal_line_crossings_per_location_entrant": "rate"
    }
  }
}

Update frequency

Line events refresh throughout the day:

Date range	Refresh cadence (UK time)
Today / recent days	Every ~10 minutes
Yesterday and historical	02:00 daily
Last full week	03:00 Mondays
Last full month / quarter / year	05:00 on the 1st

Body parameters

Example request

Example response

Update frequency

Related