Capture rate
Entry rate as a proportion of passing traffic.
Returns the entry rate as a proportion of passing traffic — i.e. entries / (entries + passers_by) — as a time-series.
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 |
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. Values: customer, staff, customer-customer, customer-staff, staff-staff |
genders | string[] | conditional | Required when breakdownByDimensions includes gender. Values: male, female |
ages | string[] | conditional | Required when breakdownByDimensions includes age. Values: 0_15, 16_24, 25_34, 35_44, 45_54, 55_64, 65_100 |
insideRecordingTimes | boolean | no | true to restrict to opening hours only. Default false |
Example request
{
"action": "metric",
"data": {
"id": "req-cr-001",
"route": "capture-rate",
"body": {
"start": "2024-04-01T00:00:00.000Z",
"end": "2024-04-07T23:59:59.000Z",
"entities": ["64a1b2c3d4e5f6a7b8c9d0e3"],
"entityType": "location",
"facets": ["segments", "summary"],
"aggregationPeriod": "day"
}
}
}Example response
req-cr-001|0|0|{
"segments": [
{ "index": "2024-04-01T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "capture_rate": 21.0 },
{ "index": "2024-04-02T00:00:00.000", "location": "64a1b2c3d4e5f6a7b8c9d0e3", "capture_rate": 19.8 }
],
"summary": [
{ "location": "64a1b2c3d4e5f6a7b8c9d0e3", "capture_rate": 20.7 }
],
"meta": {
"units": {
"capture_rate": "percentage"
}
}
}
nullmeans the rate is undefined (no passers-by or no data captured). Don’t coercenullto0.
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 |
Related
- Entries
- Passers-by
- Line capture rate — capture rate at a named zone
- Metrics API overview