@trillboards/api-client 3.2.1 → 3.2.5

package/dist/generated.d.mts

@@ -2384,7 +2384,7 @@ type Partner = {
 type PartnerAdDeliveryProfile = {
     /** Android SDK API level as reported by the device; `null` when not reported, and then no Android rule fires at all. Below 23 forces `mode: vast_fallback` and turns `auto_recovery_enabled` off. 23-25 with desugaring reported off only appends a warning to `notes` and leaves the mode alone. */
     android_api_level?: number | null;
-    /** Whether the SERVER may auto-enqueue recovery device commands for this device — the `refresh_ads` and `restart` it issues when a screen heartbeats online without recent VAST requests, or with stalled playback. It is not a client-side setting, and it goes false alongside every `vast_fallback` verdict so we do not restart a device whose player we already know is the wrong one. */
+    /** Whether the SERVER may auto-enqueue recovery device commands for this device — the `refresh_ads` and `restart` it issues when a screen heartbeats online without recent VAST requests, or with stalled playback. It is not a client-side setting, and it goes false alongside every `vast_fallback` verdict so we do not restart a device whose player we already know is the wrong one. Even when true, a recovery command is queued only for a device that acts on commands, meaning one that acknowledged a command (`POST /device/{deviceId}/command/{commandId}/ack`) in the last 7 days, or that was handed none in that time. A device that let a delivered command expire unacknowledged, and acknowledged none, is sent no recovery command until that command is 7 days old. */
     auto_recovery_enabled?: boolean;
     /** Echoed back from the device's own heartbeat telemetry, or `unknown` when the device never reported one. It selects which compatibility rules run: `android_native` enables the Android API-level gate, `html5_webview` the Chromium-version checks; `disabled` and `unknown` skip both, so no mode change can result from those. */
     ima_integration?: "android_native" | "html5_webview" | "disabled" | "unknown";
@@ -6275,7 +6275,7 @@ interface exportDatasetOperation {
     };
 }
 /**
- * Geographic audience-density panel (data-licensing)
+ * Geographic audience panel (data-licensing)
  * GET /v1/partner/data/geohash-audience-panel
  */
 interface getGeohashAudiencePanelOperation {
@@ -6292,8 +6292,12 @@ interface getGeohashAudiencePanelOperation {
     };
     response: {
         data?: {
+            /** The build of the day this page read (UTC, `YYYY-MM-DD HH:MM:SS.mmm`). A day with no build is answered `404` `day_not_built`. */
+            built_at: string;
             /** Day exported (UTC). */
             date: string;
+            /** The panel's definition (2 since 2026-10-19). */
+            definition_version: number;
             /** Rows per page this response was read with. */
             limit: number;
             /** The `offset` of the next page, or `null` on the last page. */
@@ -6302,28 +6306,82 @@ interface getGeohashAudiencePanelOperation {
             offset: number;
             /** Integer partner_id (`partners.partner_id`). */
             partner_id: number;
-            /** Per-row aggregates, every cell with its counts. */
+            /** One row per (hour, geohash6, venue_category), every cell with its counts. */
             rows: Array<{
-                /** Average attention score. `null`: not measured in this panel, which is built from radio pings; camera-measured attention is in the camera datasets. */
+                /** Mean device head-pose index 0-1 over the camera windows. `null` when the cell-hour holds no camera window. */
                 avg_attention: number | null;
-                /** Average dwell seconds. `null`: not measured in this panel, which is built from radio pings; camera-measured dwell is in the camera datasets. */
+                /** Mean dwell per window in milliseconds, each window's dwell capped at its own length, over the windows that carry a start time (dwell_capped_windows). `null`: No window of the row carries a start time (dwell_capped_windows = 0). */
+                avg_dwell_ms: number | null;
+                /** Mean capped dwell per camera window, seconds (`avg_dwell_ms` / 1000). `null` when no camera window of the cell-hour carries a start time. */
                 avg_dwell_seconds: number | null;
-                /** Average face count per observation. `null`: not measured in this panel, which is built from radio pings; camera-measured faces are in the camera datasets. */
+                /** Mean faces per camera window. `null` when the cell-hour holds no camera window. */
                 avg_face_count: number | null;
-                /** 6-character geohash bucket. */
+                /** The windows avg_dwell_ms averages: camera windows that carry a start time. */
+                dwell_capped_windows: number;
+                /** Of those, the face-backed windows. */
+                face_backed_windows: number;
+                /** Of those, the identifiers whose strongest signal was below it: the devices around the screen. Sources that report no signal strength (mDNS, SSDP, HTTP probe) are in neither split. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                far_key_slots: number | null;
+                /** far_key_slots / radio_slots. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                far_keys_per_slot: number | null;
+                /** Median age of those fixes at the window's instant. `null`: No camera window of the row was placed by a trail fix. */
+                fix_age_p50_s: number | null;
+                /** 90th-percentile age of those fixes. `null`: No camera window of the row was placed by a trail fix. */
+                fix_age_p90_s: number | null;
+                /** Camera windows of a fixed screen with no trail fix in the lookback, placed at its registered site. */
+                fixed_site_positioned_windows: number;
+                /** Geohash-6 cell (about 1.2 x 0.6 km) where the screen was at the unit's instant: on its map-matched path, else at its last GPS trail fix, else (a fixed screen) at its registered site. */
                 geohash6: string;
-                /** Hour bucket as the integer hour (0..23) cast to string. */
+                /** Start of the UTC hour, `YYYY-MM-DD HH:MM:SS`. A camera window counts in the hour it closed, a radio slot in the hour of its midpoint. */
                 hour: string;
-                /** Income tier bucket (e.g. `low`, `mid`, `high`). */
-                income_tier: string;
-                /** Observation count. */
-                observation_count: number;
-                /** Distinct screen count contributing to this bucket. */
-                screen_count: number;
-                /** Unique-device count. */
-                unique_devices: number;
-                /** Venue category from `screens_live.venue_category`. */
+                /** `null` on every row: no income source joins the panel (definition 1 wrote `unknown`). */
+                income_tier: string | null;
+                /** Camera windows placed at the screen's last GPS fix at or before their instant. */
+                last_fix_positioned_windows: number;
+                /** The near-field boundary of the row's day: the active pass_audience method register's rf_near_rssi_dbm, the boundary the in-cab radio uses. */
+                near_field_rssi_dbm: number;
+                /** Of those, the identifiers whose strongest signal in the slot was at or above near_field_rssi_dbm: in the vehicle or against the screen. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                near_key_slots: number | null;
+                /** near_key_slots / radio_slots: near-field identifiers concurrent in one slot. The approved metric radio_identifiers_per_person converts near-field passenger Bluetooth identifiers to people: it is measured in the cab, where the driver's phone and the vehicle's own devices are removed by role. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                near_keys_per_slot: number | null;
+                /** Radio observations (pings) of those identifiers in the cell-hour (`radio_pings`). `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                observation_count: number | null;
+                /** Camera-graded windows (face- or person-backed, ~10 s each) placed in the cell. */
+                observation_windows: number;
+                /** Exact 95th percentile of the per-window face reading over the row's windows. `null`: No camera window in the row. */
+                p95_face_count: number | null;
+                /** Camera windows placed on the map-matched vehicle path at their instant. */
+                path_positioned_windows: number;
+                /** Of those, the person-backed windows. */
+                person_backed_windows: number;
+                /** The windows persons_per_window averages. */
+                person_reading_windows: number;
+                /** Mean people in view per camera window, faced or not: per window the larger of its mean person count and its mean face count (the in-cab panel's persons reading), over the windows that carry one. `null`: No camera window of the row carries a persons reading (person_reading_windows = 0). */
+                persons_per_window: number | null;
+                /** Radio slots of a fixed screen with no trail fix in the lookback, placed at its registered site. */
+                radio_fixed_site_positioned_slots: number;
+                /** Radio slots placed at the screen's last GPS fix at or before their midpoint. */
+                radio_last_fix_positioned_slots: number;
+                /** Radio slots placed on the map-matched path at their midpoint. */
+                radio_path_positioned_slots: number;
+                /** Radio observations of the visitor identifiers in the row's slots. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                radio_pings: number | null;
+                /** Distinct screens whose radio slots the row holds. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                radio_screens: number | null;
+                /** 6-minute radio slots of screens placed in the cell: a slot in which the screen's visitor radio read an identifier (a slot in which the scanner reported only the screen's own Wi-Fi access point does not show the visitor radio ran, and is no slot here). 0 when only camera windows fell in the row. */
+                radio_slots: number;
+                /** Distinct screens whose radio slots the cell-hour holds (`radio_screens`). `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                screen_count: number | null;
+                /** Distinct screens whose camera windows the row holds. */
+                screens: number;
+                /** Distinct visitor-source radio identifiers (BLE, mDNS, SSDP, HTTP probe) over the cell-hour's radio slots, exact. A distinct count: rows do not add. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                unique_devices: number | null;
+                /** The screen's registered venue category (`transit` for a vehicle screen); empty when the registry holds none. */
                 venue_category: string;
+                /** Visitor-source radio identifiers (BLE, mDNS, SSDP, HTTP probe) distinct within each slot, summed over the slots. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                visitor_key_slots: number | null;
+                /** visitor_key_slots / radio_slots: identifiers concurrent in one 6-minute slot, every visitor source and both fields. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                visitor_keys_per_slot: number | null;
             }>;
             /** `true` when more cells follow this page: request `next_offset`. */
             truncated: boolean;

package/dist/generated.d.ts

@@ -2384,7 +2384,7 @@ type Partner = {
 type PartnerAdDeliveryProfile = {
     /** Android SDK API level as reported by the device; `null` when not reported, and then no Android rule fires at all. Below 23 forces `mode: vast_fallback` and turns `auto_recovery_enabled` off. 23-25 with desugaring reported off only appends a warning to `notes` and leaves the mode alone. */
     android_api_level?: number | null;
-    /** Whether the SERVER may auto-enqueue recovery device commands for this device — the `refresh_ads` and `restart` it issues when a screen heartbeats online without recent VAST requests, or with stalled playback. It is not a client-side setting, and it goes false alongside every `vast_fallback` verdict so we do not restart a device whose player we already know is the wrong one. */
+    /** Whether the SERVER may auto-enqueue recovery device commands for this device — the `refresh_ads` and `restart` it issues when a screen heartbeats online without recent VAST requests, or with stalled playback. It is not a client-side setting, and it goes false alongside every `vast_fallback` verdict so we do not restart a device whose player we already know is the wrong one. Even when true, a recovery command is queued only for a device that acts on commands, meaning one that acknowledged a command (`POST /device/{deviceId}/command/{commandId}/ack`) in the last 7 days, or that was handed none in that time. A device that let a delivered command expire unacknowledged, and acknowledged none, is sent no recovery command until that command is 7 days old. */
     auto_recovery_enabled?: boolean;
     /** Echoed back from the device's own heartbeat telemetry, or `unknown` when the device never reported one. It selects which compatibility rules run: `android_native` enables the Android API-level gate, `html5_webview` the Chromium-version checks; `disabled` and `unknown` skip both, so no mode change can result from those. */
     ima_integration?: "android_native" | "html5_webview" | "disabled" | "unknown";
@@ -6275,7 +6275,7 @@ interface exportDatasetOperation {
     };
 }
 /**
- * Geographic audience-density panel (data-licensing)
+ * Geographic audience panel (data-licensing)
  * GET /v1/partner/data/geohash-audience-panel
  */
 interface getGeohashAudiencePanelOperation {
@@ -6292,8 +6292,12 @@ interface getGeohashAudiencePanelOperation {
     };
     response: {
         data?: {
+            /** The build of the day this page read (UTC, `YYYY-MM-DD HH:MM:SS.mmm`). A day with no build is answered `404` `day_not_built`. */
+            built_at: string;
             /** Day exported (UTC). */
             date: string;
+            /** The panel's definition (2 since 2026-10-19). */
+            definition_version: number;
             /** Rows per page this response was read with. */
             limit: number;
             /** The `offset` of the next page, or `null` on the last page. */
@@ -6302,28 +6306,82 @@ interface getGeohashAudiencePanelOperation {
             offset: number;
             /** Integer partner_id (`partners.partner_id`). */
             partner_id: number;
-            /** Per-row aggregates, every cell with its counts. */
+            /** One row per (hour, geohash6, venue_category), every cell with its counts. */
             rows: Array<{
-                /** Average attention score. `null`: not measured in this panel, which is built from radio pings; camera-measured attention is in the camera datasets. */
+                /** Mean device head-pose index 0-1 over the camera windows. `null` when the cell-hour holds no camera window. */
                 avg_attention: number | null;
-                /** Average dwell seconds. `null`: not measured in this panel, which is built from radio pings; camera-measured dwell is in the camera datasets. */
+                /** Mean dwell per window in milliseconds, each window's dwell capped at its own length, over the windows that carry a start time (dwell_capped_windows). `null`: No window of the row carries a start time (dwell_capped_windows = 0). */
+                avg_dwell_ms: number | null;
+                /** Mean capped dwell per camera window, seconds (`avg_dwell_ms` / 1000). `null` when no camera window of the cell-hour carries a start time. */
                 avg_dwell_seconds: number | null;
-                /** Average face count per observation. `null`: not measured in this panel, which is built from radio pings; camera-measured faces are in the camera datasets. */
+                /** Mean faces per camera window. `null` when the cell-hour holds no camera window. */
                 avg_face_count: number | null;
-                /** 6-character geohash bucket. */
+                /** The windows avg_dwell_ms averages: camera windows that carry a start time. */
+                dwell_capped_windows: number;
+                /** Of those, the face-backed windows. */
+                face_backed_windows: number;
+                /** Of those, the identifiers whose strongest signal was below it: the devices around the screen. Sources that report no signal strength (mDNS, SSDP, HTTP probe) are in neither split. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                far_key_slots: number | null;
+                /** far_key_slots / radio_slots. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                far_keys_per_slot: number | null;
+                /** Median age of those fixes at the window's instant. `null`: No camera window of the row was placed by a trail fix. */
+                fix_age_p50_s: number | null;
+                /** 90th-percentile age of those fixes. `null`: No camera window of the row was placed by a trail fix. */
+                fix_age_p90_s: number | null;
+                /** Camera windows of a fixed screen with no trail fix in the lookback, placed at its registered site. */
+                fixed_site_positioned_windows: number;
+                /** Geohash-6 cell (about 1.2 x 0.6 km) where the screen was at the unit's instant: on its map-matched path, else at its last GPS trail fix, else (a fixed screen) at its registered site. */
                 geohash6: string;
-                /** Hour bucket as the integer hour (0..23) cast to string. */
+                /** Start of the UTC hour, `YYYY-MM-DD HH:MM:SS`. A camera window counts in the hour it closed, a radio slot in the hour of its midpoint. */
                 hour: string;
-                /** Income tier bucket (e.g. `low`, `mid`, `high`). */
-                income_tier: string;
-                /** Observation count. */
-                observation_count: number;
-                /** Distinct screen count contributing to this bucket. */
-                screen_count: number;
-                /** Unique-device count. */
-                unique_devices: number;
-                /** Venue category from `screens_live.venue_category`. */
+                /** `null` on every row: no income source joins the panel (definition 1 wrote `unknown`). */
+                income_tier: string | null;
+                /** Camera windows placed at the screen's last GPS fix at or before their instant. */
+                last_fix_positioned_windows: number;
+                /** The near-field boundary of the row's day: the active pass_audience method register's rf_near_rssi_dbm, the boundary the in-cab radio uses. */
+                near_field_rssi_dbm: number;
+                /** Of those, the identifiers whose strongest signal in the slot was at or above near_field_rssi_dbm: in the vehicle or against the screen. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                near_key_slots: number | null;
+                /** near_key_slots / radio_slots: near-field identifiers concurrent in one slot. The approved metric radio_identifiers_per_person converts near-field passenger Bluetooth identifiers to people: it is measured in the cab, where the driver's phone and the vehicle's own devices are removed by role. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                near_keys_per_slot: number | null;
+                /** Radio observations (pings) of those identifiers in the cell-hour (`radio_pings`). `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                observation_count: number | null;
+                /** Camera-graded windows (face- or person-backed, ~10 s each) placed in the cell. */
+                observation_windows: number;
+                /** Exact 95th percentile of the per-window face reading over the row's windows. `null`: No camera window in the row. */
+                p95_face_count: number | null;
+                /** Camera windows placed on the map-matched vehicle path at their instant. */
+                path_positioned_windows: number;
+                /** Of those, the person-backed windows. */
+                person_backed_windows: number;
+                /** The windows persons_per_window averages. */
+                person_reading_windows: number;
+                /** Mean people in view per camera window, faced or not: per window the larger of its mean person count and its mean face count (the in-cab panel's persons reading), over the windows that carry one. `null`: No camera window of the row carries a persons reading (person_reading_windows = 0). */
+                persons_per_window: number | null;
+                /** Radio slots of a fixed screen with no trail fix in the lookback, placed at its registered site. */
+                radio_fixed_site_positioned_slots: number;
+                /** Radio slots placed at the screen's last GPS fix at or before their midpoint. */
+                radio_last_fix_positioned_slots: number;
+                /** Radio slots placed on the map-matched path at their midpoint. */
+                radio_path_positioned_slots: number;
+                /** Radio observations of the visitor identifiers in the row's slots. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                radio_pings: number | null;
+                /** Distinct screens whose radio slots the row holds. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                radio_screens: number | null;
+                /** 6-minute radio slots of screens placed in the cell: a slot in which the screen's visitor radio read an identifier (a slot in which the scanner reported only the screen's own Wi-Fi access point does not show the visitor radio ran, and is no slot here). 0 when only camera windows fell in the row. */
+                radio_slots: number;
+                /** Distinct screens whose radio slots the cell-hour holds (`radio_screens`). `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                screen_count: number | null;
+                /** Distinct screens whose camera windows the row holds. */
+                screens: number;
+                /** Distinct visitor-source radio identifiers (BLE, mDNS, SSDP, HTTP probe) over the cell-hour's radio slots, exact. A distinct count: rows do not add. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                unique_devices: number | null;
+                /** The screen's registered venue category (`transit` for a vehicle screen); empty when the registry holds none. */
                 venue_category: string;
+                /** Visitor-source radio identifiers (BLE, mDNS, SSDP, HTTP probe) distinct within each slot, summed over the slots. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                visitor_key_slots: number | null;
+                /** visitor_key_slots / radio_slots: identifiers concurrent in one 6-minute slot, every visitor source and both fields. `null`: No radio slot in the row (radio_slots = 0): only camera windows were placed there, and the radio was not read. */
+                visitor_keys_per_slot: number | null;
             }>;
             /** `true` when more cells follow this page: request `next_offset`. */
             truncated: boolean;