@lessly/sdk-app 105.4.0 → 105.5.0

package/src/gen/types.gen.ts

@@ -135113,6 +135113,175 @@ lookbackDays: number
 costLastSyncedAt: (string | null)
 }
 
+export interface TrackingHeatmapsGetInput {
+/**
+ * End of the period, ISO 8601: recordings that started at or before it.
+ */
+to: string
+/**
+ * Start of the period, ISO 8601 (e.g. 2026-10-01T00:00:00Z): recordings that started at or after it. At most 30 days before `to`.
+ */
+from: string
+/**
+ * Required: a map is drawn for one kind of device (desktop, tablet or mobile), since layouts differ.
+ */
+device: ("desktop" | "tablet" | "mobile")
+/**
+ * The page, as tracking_heatmaps_pages returns it: host + normalized path, e.g. shop.example.com/pricing.
+ */
+pageKey: string
+/**
+ * true: only sessions with a conversion or a payment; false: only sessions without one. Omit for both.
+ */
+converted?: boolean
+/**
+ * Only recordings whose entry page carried this utm_source, e.g. google.
+ */
+utmSource?: string
+/**
+ * Only recordings whose entry page carried this utm_campaign, e.g. spring.
+ */
+utmCampaign?: string
+}
+
+export interface TrackingHeatmapsGetOutput {
+/**
+ * At most 300 elements, most clicked first.
+ */
+clicks: {
+/**
+ * Clicks on it.
+ */
+count: number
+/**
+ * Clicks on a 50x50 grid laid over the element; empty cells left out.
+ */
+points: {
+/**
+ * Cell centre across the element, 0 (left edge) to 1 (right edge).
+ */
+rx: number
+/**
+ * Cell centre down the element, 0 (top) to 1 (bottom).
+ */
+ry: number
+/**
+ * Clicks in the cell.
+ */
+count: number
+}[]
+/**
+ * CSS selector of the clicked element, as built in the browser.
+ */
+selector: string
+/**
+ * Recordings with at least one click on it.
+ */
+sessions: number
+}[]
+/**
+ * How far down the page the sessions scrolled.
+ */
+scroll: {
+/**
+ * 20 shares (0..1): reached[i] is the share of the sessions that reported a scroll depth on the page whose deepest point is at least (i+1)*5% of the page height (reached[9] = the 50% line). Empty below the threshold.
+ */
+reached: number[]
+/**
+ * Median page height in px over those sessions. Null below the threshold or without any scroll sample.
+ */
+medianDocHeight: (number | null)
+}
+/**
+ * Recordings of the period, device and filters with a click or a scroll sample on this page.
+ */
+sessions: number
+/**
+ * The latest recording of this device (any time in retention) whose segment loaded this page with a full snapshot at its start. Null when none: a page only ever reached by in-app navigation has no picture of its own.
+ */
+background: ({
+/**
+ * Page load of the segment.
+ */
+pid: string
+/**
+ * Consent (re)start of the segment.
+ */
+seg: number
+/**
+ * Recording to draw the page from. Pass to tracking_recordings_chunks_get with pid and seg.
+ */
+recordingId: string
+} | null)
+/**
+ * True when sessions < 10: clicks and scroll.reached are then empty and medianDocHeight null.
+ */
+belowThreshold: boolean
+}
+
+export interface TrackingHeatmapsPagesInput {
+/**
+ * Only pages whose key contains this text, case-insensitively, e.g. /pricing.
+ */
+q?: string
+/**
+ * End of the period, ISO 8601: recordings that started at or before it.
+ */
+to: string
+/**
+ * Start of the period, ISO 8601 (e.g. 2026-10-01T00:00:00Z): recordings that started at or after it. At most 30 days before `to`.
+ */
+from: string
+/**
+ * Pages per page of results, 1 to 100 (default 50).
+ */
+limit?: number
+/**
+ * Continue a previous page: pass the nextCursor it returned.
+ */
+cursor?: string
+/**
+ * Only recordings from this kind of device: desktop, tablet or mobile. Omit for all.
+ */
+device?: ("desktop" | "tablet" | "mobile")
+/**
+ * true: only sessions with a conversion or a payment; false: only sessions without one. Omit for both.
+ */
+converted?: boolean
+/**
+ * Only recordings whose entry page carried this utm_source, e.g. google.
+ */
+utmSource?: string
+/**
+ * Only recordings whose entry page carried this utm_campaign, e.g. spring.
+ */
+utmCampaign?: string
+}
+
+export interface TrackingHeatmapsPagesOutput {
+/**
+ * Most sessions first.
+ */
+pages: {
+/**
+ * Clicks on this page in those recordings.
+ */
+clicks: number
+/**
+ * host + normalized path: no query, no hash, ids and hashes replaced by *. Pass it to tracking_heatmaps_get.
+ */
+pageKey: string
+/**
+ * Recordings of the period and filters with a click or a scroll sample on this page.
+ */
+sessions: number
+}[]
+/**
+ * Pass back as cursor for the next page. Null on the last page.
+ */
+nextCursor: (string | null)
+}
+
 export interface TrackingIdentityHealthInput {
 
 }
@@ -136187,6 +136356,10 @@ limit?: number
  * Continue a previous page: pass the nextCursor it returned. Omit to start from the newest recording.
  */
 cursor?: string
+/**
+ * Only recordings from this kind of device, as classified on ingest: desktop, tablet or mobile.
+ */
+device?: ("desktop" | "tablet" | "mobile")
 /**
  * true: only sessions with a conversion or a payment; false: only sessions without one. Omit for both.
  */