| key |
id |
string(255)* |
= |
The id field uniquely identifies the entity record. |
| timeline |
periodStart |
dateTime* |
=< >= |
The date and time at which the milestones engine begins capturing the volume events for each reporting day. Format: YYYY-MM-DD 00:00:00 UTC. |
| link |
batch |
Batch* |
= |
The Batch for which this BatchRun is an instance. |
| link |
batchRun |
BatchRun* |
= |
The BatchRun in which the Instrument is deliverd. |
|
datasetDescription |
string(255) |
|
Name of the data set provided. |
|
datasetUserName |
string(255) |
|
The display name of the data subscriber account (e.g., 'S&P'). Used to scope the dataset to a specific customer delivery. |
|
modificationTime |
dateTime* |
|
Data bank modification time. |
|
outputFrequency |
string(50) |
|
How often data is sent: Daily file. Each file covers one calendar day (00:00–23:59 UTC). |
|
regionEnterCount |
long(999000000000) |
|
The number of distinct asset trips where the asset crossed into the region boundary and was fully confirmed inside during this calendar day. |
|
regionEodStayCount |
long(999000000000) |
|
The count of unique assets that were physically inside the region at the daily snapshot timestamp of 23:59 UTC (midnight UTC). |
|
regionExitCount |
long(999000000000) |
|
The number of distinct asset trips where the asset departed the region boundary and the exit was confirmed during this calendar day. |
|
regionH3Resolution |
long(10) |
|
The zoom level of the Uber H3 hexagonal grid applied to map the region. Resolution 7 = each hexagon covers approximately 5 km². All current regions use Resolution 7. |
|
regionName |
string(255) |
|
Regions are defined by one or more H3-7 hex cells. Example: 'Chicago', 'Los Angeles and Long Beach'. |
|
regionType |
string(255) |
|
One of two values: 'Port Polygon' (hexes contained within the port region) OR 'Catchment Area' (hexes contained within the broader port region, including warehouses, rail ramps, and other relevant logistics facilities). |