@lessly/sdk-app 103.0.1 → 104.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -4
- package/dist/_types/gen/client.gen.d.ts +8 -1
- package/dist/_types/gen/tracking/index.d.ts +1 -1
- package/dist/_types/gen/tracking/queryOptions.gen.d.ts +13 -1
- package/dist/_types/gen/types.gen.d.ts +342 -5
- package/dist/{chunk-3PMJZ47D.js → chunk-FSDRL4AE.js} +101 -2
- package/dist/chunk-FSDRL4AE.js.map +1 -0
- package/dist/index.cjs +106 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +8 -2
- package/dist/index.js.map +1 -1
- package/dist/playground/index.cjs.map +1 -1
- package/dist/playground/index.js +1 -1
- package/dist/tracking/index.cjs +15 -0
- package/dist/tracking/index.cjs.map +1 -1
- package/dist/tracking/index.js +13 -1
- package/dist/tracking/index.js.map +1 -1
- package/package.json +2 -2
- package/src/gen/bindings.gen.ts +99 -0
- package/src/gen/client.gen.ts +13 -0
- package/src/gen/manifest.gen.ts +7 -1
- package/src/gen/tracking/index.ts +1 -1
- package/src/gen/tracking/queryOptions.gen.ts +21 -0
- package/src/gen/types.gen.ts +348 -5
- package/dist/chunk-3PMJZ47D.js.map +0 -1
package/src/gen/types.gen.ts
CHANGED
|
@@ -93705,7 +93705,7 @@ baseEnvironmentId: (string | null)
|
|
|
93705
93705
|
}
|
|
93706
93706
|
|
|
93707
93707
|
export interface DeploymentEventsListByEnvironmentInput {
|
|
93708
|
-
type?: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93708
|
+
type?: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "service.source.reconnected" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93709
93709
|
limit?: number
|
|
93710
93710
|
since?: string
|
|
93711
93711
|
until?: string
|
|
@@ -93714,7 +93714,7 @@ environmentId: string
|
|
|
93714
93714
|
|
|
93715
93715
|
export type DeploymentEventsListByEnvironmentOutput = {
|
|
93716
93716
|
id: string
|
|
93717
|
-
type: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93717
|
+
type: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "service.source.reconnected" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93718
93718
|
payload: {
|
|
93719
93719
|
[k: string]: unknown
|
|
93720
93720
|
}
|
|
@@ -93727,7 +93727,7 @@ environmentId: (string | null)
|
|
|
93727
93727
|
}[]
|
|
93728
93728
|
|
|
93729
93729
|
export interface DeploymentEventsListByServiceInput {
|
|
93730
|
-
type?: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93730
|
+
type?: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "service.source.reconnected" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93731
93731
|
limit?: number
|
|
93732
93732
|
since?: string
|
|
93733
93733
|
until?: string
|
|
@@ -93737,7 +93737,7 @@ deploymentId?: string
|
|
|
93737
93737
|
|
|
93738
93738
|
export type DeploymentEventsListByServiceOutput = {
|
|
93739
93739
|
id: string
|
|
93740
|
-
type: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93740
|
+
type: ("deployment.queued" | "deployment.build.started" | "deployment.build.succeeded" | "deployment.build.failed" | "deployment.deploying" | "deployment.variable.ignored" | "deployment.healthcheck.passed" | "deployment.healthcheck.failed" | "deployment.healthy" | "deployment.failed" | "deployment.replaced" | "deployment.sourcemaps.uploaded" | "deployment.sourcemaps.upload-failed" | "deployment.requeue-failed" | "deployment.release.started" | "deployment.release.log" | "deployment.release.succeeded" | "deployment.release.failed" | "replica.restarted" | "service.scaled" | "service.restarted" | "service.restart-failed" | "domain.verified" | "domain.tls.issued" | "domain.tls.failed" | "domain.www-tls.issued" | "domain.www-tls.failed" | "domain.routing.active" | "domain.routing.failed" | "domain.routing.reapplied" | "domain.removed" | "domain.governance.mirror-failed" | "service.slept" | "service.woke" | "service.wake_failed" | "service.sleep-enabled" | "service.sleep-disabled" | "service.sleep-enable-failed" | "service.public_domain.changed" | "service.source.reconnected" | "cloud-sql.instance.stopped" | "cloud-sql.instance.started" | "cloud-sql.instance.stop-failed" | "cloud-sql.instance.start-failed" | "suspension.workload-stopped" | "suspension.workload-restored" | "managed-service.restarted" | "managed-service.port-leak-healed" | "managed-service.backup-reset")
|
|
93741
93741
|
payload: {
|
|
93742
93742
|
[k: string]: unknown
|
|
93743
93743
|
}
|
|
@@ -134028,7 +134028,7 @@ export interface TrackingEntitlementDropsGetInput {
|
|
|
134028
134028
|
|
|
134029
134029
|
export interface TrackingEntitlementDropsGetOutput {
|
|
134030
134030
|
/**
|
|
134031
|
-
* Null when no event was refused this month.
|
|
134031
|
+
* Null when no event and no session recording was refused this month.
|
|
134032
134032
|
*/
|
|
134033
134033
|
drops: ({
|
|
134034
134034
|
/**
|
|
@@ -134059,6 +134059,10 @@ droppedBatches: number
|
|
|
134059
134059
|
* First refused flush this month, ISO 8601 UTC.
|
|
134060
134060
|
*/
|
|
134061
134061
|
firstDroppedAt: string
|
|
134062
|
+
/**
|
|
134063
|
+
* Session recordings not kept this month because billing refused them (trial recording limit reached, billing paused).
|
|
134064
|
+
*/
|
|
134065
|
+
droppedRecordings: number
|
|
134062
134066
|
} | null)
|
|
134063
134067
|
/**
|
|
134064
134068
|
* First day of the current UTC month the figures cover, YYYY-MM-DD, e.g. 2026-09-01.
|
|
@@ -135360,6 +135364,32 @@ profileId: string
|
|
|
135360
135364
|
* This erasure attempt. The completion event carries the same value under the same name, so a step recognises its own completion even when another workflow is erasing the same person at the same moment.
|
|
135361
135365
|
*/
|
|
135362
135366
|
requestId: string
|
|
135367
|
+
/**
|
|
135368
|
+
* What happened to the session recordings of this person. Unlike the events archive, they are deleted per person.
|
|
135369
|
+
*/
|
|
135370
|
+
recordings: {
|
|
135371
|
+
/**
|
|
135372
|
+
* Session recordings of this person removed, across every browser they were seen on.
|
|
135373
|
+
*/
|
|
135374
|
+
deleted: number
|
|
135375
|
+
/**
|
|
135376
|
+
* The stored files of those recordings.
|
|
135377
|
+
*/
|
|
135378
|
+
objects: {
|
|
135379
|
+
/**
|
|
135380
|
+
* Stored recording files deleted now.
|
|
135381
|
+
*/
|
|
135382
|
+
deleted: number
|
|
135383
|
+
/**
|
|
135384
|
+
* Recording files that were already gone.
|
|
135385
|
+
*/
|
|
135386
|
+
missing: number
|
|
135387
|
+
/**
|
|
135388
|
+
* Recordings whose files could not be deleted at once and are being deleted in the background; 0 normally.
|
|
135389
|
+
*/
|
|
135390
|
+
pending: number
|
|
135391
|
+
}
|
|
135392
|
+
}
|
|
135363
135393
|
}
|
|
135364
135394
|
|
|
135365
135395
|
export interface TrackingProfilesExportInput {
|
|
@@ -135886,6 +135916,319 @@ enabled: boolean
|
|
|
135886
135916
|
sampleRate: number
|
|
135887
135917
|
}
|
|
135888
135918
|
|
|
135919
|
+
export interface TrackingRecordingsChunksGetInput {
|
|
135920
|
+
/**
|
|
135921
|
+
* The recording id (uuid), from tracking_recordings_list.
|
|
135922
|
+
*/
|
|
135923
|
+
id: string
|
|
135924
|
+
/**
|
|
135925
|
+
* Page load of the segment, from the segments of tracking_recordings_get.
|
|
135926
|
+
*/
|
|
135927
|
+
pid: string
|
|
135928
|
+
/**
|
|
135929
|
+
* Consent (re)start of the segment within that page load, from tracking_recordings_get.
|
|
135930
|
+
*/
|
|
135931
|
+
seg: number
|
|
135932
|
+
/**
|
|
135933
|
+
* Continue a segment: pass the nextSeq the previous page returned. Default 0, the start.
|
|
135934
|
+
*/
|
|
135935
|
+
fromSeq?: number
|
|
135936
|
+
/**
|
|
135937
|
+
* Decoded bytes per page (default 2097152, max 8388608). A page ends at the first whole payload past it and always holds at least one.
|
|
135938
|
+
*/
|
|
135939
|
+
maxBytes?: number
|
|
135940
|
+
}
|
|
135941
|
+
|
|
135942
|
+
export interface TrackingRecordingsChunksGetOutput {
|
|
135943
|
+
/**
|
|
135944
|
+
* Stretches of the segment that could not be played: lost slices, or payloads that did not decode. Show "part of the recording is lost" there.
|
|
135945
|
+
*/
|
|
135946
|
+
gaps: {
|
|
135947
|
+
/**
|
|
135948
|
+
* Last lost slice, inclusive.
|
|
135949
|
+
*/
|
|
135950
|
+
toSeq: number
|
|
135951
|
+
/**
|
|
135952
|
+
* First lost slice.
|
|
135953
|
+
*/
|
|
135954
|
+
fromSeq: number
|
|
135955
|
+
}[]
|
|
135956
|
+
/**
|
|
135957
|
+
* rrweb events of this page of the segment, in order. Feed them to the player.
|
|
135958
|
+
*/
|
|
135959
|
+
events: unknown[]
|
|
135960
|
+
/**
|
|
135961
|
+
* Pass back as fromSeq for the next page. Null once the segment is read to its end. On an active recording it can equal the fromSeq you sent, with no events: the last part is still arriving — ask again later.
|
|
135962
|
+
*/
|
|
135963
|
+
nextSeq: (number | null)
|
|
135964
|
+
}
|
|
135965
|
+
|
|
135966
|
+
export interface TrackingRecordingsGetInput {
|
|
135967
|
+
/**
|
|
135968
|
+
* The recording id (uuid), from tracking_recordings_list.
|
|
135969
|
+
*/
|
|
135970
|
+
id: string
|
|
135971
|
+
}
|
|
135972
|
+
|
|
135973
|
+
export interface TrackingRecordingsGetOutput {
|
|
135974
|
+
/**
|
|
135975
|
+
* The recording id. Pass it to tracking_recordings_get.
|
|
135976
|
+
*/
|
|
135977
|
+
id: string
|
|
135978
|
+
/**
|
|
135979
|
+
* desktop, mobile or tablet, from the browser. Null when unknown.
|
|
135980
|
+
*/
|
|
135981
|
+
device: (string | null)
|
|
135982
|
+
/**
|
|
135983
|
+
* Tracker events of the session, oldest first, at most 2000.
|
|
135984
|
+
*/
|
|
135985
|
+
events: {
|
|
135986
|
+
/**
|
|
135987
|
+
* When the event happened, ISO 8601, browser clock.
|
|
135988
|
+
*/
|
|
135989
|
+
at: string
|
|
135990
|
+
/**
|
|
135991
|
+
* Event name: page_view, a custom name, a conversion or a revenue event.
|
|
135992
|
+
*/
|
|
135993
|
+
name: string
|
|
135994
|
+
/**
|
|
135995
|
+
* The value the event carried. Null when none.
|
|
135996
|
+
*/
|
|
135997
|
+
revenue: ({
|
|
135998
|
+
/**
|
|
135999
|
+
* ISO 4217 code, e.g. EUR.
|
|
136000
|
+
*/
|
|
136001
|
+
currency: (string | null)
|
|
136002
|
+
/**
|
|
136003
|
+
* Amount in minor units, e.g. 1999 = 19.99.
|
|
136004
|
+
*/
|
|
136005
|
+
amountMinor: number
|
|
136006
|
+
} | null)
|
|
136007
|
+
/**
|
|
136008
|
+
* Milliseconds from the start of the recording on the player clock; negative when it happened before recording began. Seek the player here.
|
|
136009
|
+
*/
|
|
136010
|
+
offsetMs: number
|
|
136011
|
+
/**
|
|
136012
|
+
* True for an event marked as a conversion or a signup, trial, subscription or payment.
|
|
136013
|
+
*/
|
|
136014
|
+
isConversion: boolean
|
|
136015
|
+
}[]
|
|
136016
|
+
/**
|
|
136017
|
+
* active: the session may still be recording; closed: finished (4 h cap).
|
|
136018
|
+
*/
|
|
136019
|
+
status: ("active" | "closed")
|
|
136020
|
+
/**
|
|
136021
|
+
* The first page recorded. Personal data: a URL can carry an email. Null when unknown.
|
|
136022
|
+
*/
|
|
136023
|
+
entryUrl: (string | null)
|
|
136024
|
+
/**
|
|
136025
|
+
* In start order — the order to play them in.
|
|
136026
|
+
*/
|
|
136027
|
+
segments: {
|
|
136028
|
+
/**
|
|
136029
|
+
* Page load id. Pass with seg to tracking_recordings_chunks_get.
|
|
136030
|
+
*/
|
|
136031
|
+
pid: string
|
|
136032
|
+
/**
|
|
136033
|
+
* Consent (re)start within the page load.
|
|
136034
|
+
*/
|
|
136035
|
+
seg: number
|
|
136036
|
+
/**
|
|
136037
|
+
* Page URL at the start of the segment. Personal data, like any URL.
|
|
136038
|
+
*/
|
|
136039
|
+
url: string
|
|
136040
|
+
/**
|
|
136041
|
+
* Start of the segment, ISO 8601 UTC.
|
|
136042
|
+
*/
|
|
136043
|
+
startedAt: string
|
|
136044
|
+
/**
|
|
136045
|
+
* Slices stored for the segment.
|
|
136046
|
+
*/
|
|
136047
|
+
chunkCount: number
|
|
136048
|
+
}[]
|
|
136049
|
+
/**
|
|
136050
|
+
* Browser viewport at the start of the recording.
|
|
136051
|
+
*/
|
|
136052
|
+
viewport: {
|
|
136053
|
+
/**
|
|
136054
|
+
* Viewport height, px.
|
|
136055
|
+
*/
|
|
136056
|
+
h: (number | null)
|
|
136057
|
+
/**
|
|
136058
|
+
* Viewport width, px.
|
|
136059
|
+
*/
|
|
136060
|
+
w: (number | null)
|
|
136061
|
+
}
|
|
136062
|
+
/**
|
|
136063
|
+
* True when the same session has an event marked as a conversion or a signup, trial, subscription or payment.
|
|
136064
|
+
*/
|
|
136065
|
+
converted: boolean
|
|
136066
|
+
/**
|
|
136067
|
+
* The person behind the visitor, resolved now, so a later merge is honoured. Null for a visitor never tied to a profile.
|
|
136068
|
+
*/
|
|
136069
|
+
profileId: (string | null)
|
|
136070
|
+
/**
|
|
136071
|
+
* When the recording started, ISO 8601 UTC, on the server clock.
|
|
136072
|
+
*/
|
|
136073
|
+
startedAt: string
|
|
136074
|
+
/**
|
|
136075
|
+
* utm_medium of the entry page. Null when untagged.
|
|
136076
|
+
*/
|
|
136077
|
+
utmMedium: (string | null)
|
|
136078
|
+
/**
|
|
136079
|
+
* utm_source of the entry page. Null when untagged.
|
|
136080
|
+
*/
|
|
136081
|
+
utmSource: (string | null)
|
|
136082
|
+
/**
|
|
136083
|
+
* Length of the recording in milliseconds.
|
|
136084
|
+
*/
|
|
136085
|
+
durationMs: number
|
|
136086
|
+
/**
|
|
136087
|
+
* Ad network of the click that opened the session: gclid for Google Ads, fbclid for Meta. Null for a non-ad arrival.
|
|
136088
|
+
*/
|
|
136089
|
+
clickIdType: (string | null)
|
|
136090
|
+
/**
|
|
136091
|
+
* utm_campaign of the entry page. Null when untagged.
|
|
136092
|
+
*/
|
|
136093
|
+
utmCampaign: (string | null)
|
|
136094
|
+
/**
|
|
136095
|
+
* Page loads (and consent re-starts) recorded in the session.
|
|
136096
|
+
*/
|
|
136097
|
+
segmentCount: number
|
|
136098
|
+
/**
|
|
136099
|
+
* Server clock minus browser clock, measured on the first slice. rrweb timestamps and `events[].at` are on the browser clock.
|
|
136100
|
+
*/
|
|
136101
|
+
clockOffsetMs: number
|
|
136102
|
+
/**
|
|
136103
|
+
* True when the session had more than 2000 events and the rest were left out.
|
|
136104
|
+
*/
|
|
136105
|
+
eventsTruncated: boolean
|
|
136106
|
+
}
|
|
136107
|
+
|
|
136108
|
+
export interface TrackingRecordingsListInput {
|
|
136109
|
+
/**
|
|
136110
|
+
* End of the period, ISO 8601: recordings that started at or before it. Default: now.
|
|
136111
|
+
*/
|
|
136112
|
+
to?: string
|
|
136113
|
+
/**
|
|
136114
|
+
* Start of the period, ISO 8601 (e.g. 2026-10-01T00:00:00Z): recordings that started at or after it. Default: 30 days before `to`, the whole retention window.
|
|
136115
|
+
*/
|
|
136116
|
+
from?: string
|
|
136117
|
+
/**
|
|
136118
|
+
* Recordings per page, 1 to 100 (default 50).
|
|
136119
|
+
*/
|
|
136120
|
+
limit?: number
|
|
136121
|
+
/**
|
|
136122
|
+
* Continue a previous page: pass the nextCursor it returned. Omit to start from the newest recording.
|
|
136123
|
+
*/
|
|
136124
|
+
cursor?: string
|
|
136125
|
+
/**
|
|
136126
|
+
* true: only sessions with a conversion or a payment; false: only sessions without one. Omit for both.
|
|
136127
|
+
*/
|
|
136128
|
+
converted?: boolean
|
|
136129
|
+
/**
|
|
136130
|
+
* Only this person: every browser they were seen on, merged profiles included.
|
|
136131
|
+
*/
|
|
136132
|
+
profileId?: string
|
|
136133
|
+
/**
|
|
136134
|
+
* Only recordings whose entry page carried this utm_source, e.g. google.
|
|
136135
|
+
*/
|
|
136136
|
+
utmSource?: string
|
|
136137
|
+
/**
|
|
136138
|
+
* Only this visitor id (one browser).
|
|
136139
|
+
*/
|
|
136140
|
+
anonymousId?: string
|
|
136141
|
+
/**
|
|
136142
|
+
* Only recordings whose entry page carried this utm_campaign, e.g. spring.
|
|
136143
|
+
*/
|
|
136144
|
+
utmCampaign?: string
|
|
136145
|
+
/**
|
|
136146
|
+
* Only recordings at least this long, in milliseconds, e.g. 30000.
|
|
136147
|
+
*/
|
|
136148
|
+
minDurationMs?: number
|
|
136149
|
+
/**
|
|
136150
|
+
* Only recordings whose entry page URL contains this text, case-insensitively, e.g. /pricing.
|
|
136151
|
+
*/
|
|
136152
|
+
entryUrlContains?: string
|
|
136153
|
+
}
|
|
136154
|
+
|
|
136155
|
+
export interface TrackingRecordingsListOutput {
|
|
136156
|
+
/**
|
|
136157
|
+
* Newest first.
|
|
136158
|
+
*/
|
|
136159
|
+
items: {
|
|
136160
|
+
/**
|
|
136161
|
+
* The recording id. Pass it to tracking_recordings_get.
|
|
136162
|
+
*/
|
|
136163
|
+
id: string
|
|
136164
|
+
/**
|
|
136165
|
+
* desktop, mobile or tablet, from the browser. Null when unknown.
|
|
136166
|
+
*/
|
|
136167
|
+
device: (string | null)
|
|
136168
|
+
/**
|
|
136169
|
+
* active: the session may still be recording; closed: finished (4 h cap).
|
|
136170
|
+
*/
|
|
136171
|
+
status: ("active" | "closed")
|
|
136172
|
+
/**
|
|
136173
|
+
* The first page recorded. Personal data: a URL can carry an email. Null when unknown.
|
|
136174
|
+
*/
|
|
136175
|
+
entryUrl: (string | null)
|
|
136176
|
+
/**
|
|
136177
|
+
* Browser viewport at the start of the recording.
|
|
136178
|
+
*/
|
|
136179
|
+
viewport: {
|
|
136180
|
+
/**
|
|
136181
|
+
* Viewport height, px.
|
|
136182
|
+
*/
|
|
136183
|
+
h: (number | null)
|
|
136184
|
+
/**
|
|
136185
|
+
* Viewport width, px.
|
|
136186
|
+
*/
|
|
136187
|
+
w: (number | null)
|
|
136188
|
+
}
|
|
136189
|
+
/**
|
|
136190
|
+
* True when the same session has an event marked as a conversion or a signup, trial, subscription or payment.
|
|
136191
|
+
*/
|
|
136192
|
+
converted: boolean
|
|
136193
|
+
/**
|
|
136194
|
+
* The person behind the visitor, resolved now, so a later merge is honoured. Null for a visitor never tied to a profile.
|
|
136195
|
+
*/
|
|
136196
|
+
profileId: (string | null)
|
|
136197
|
+
/**
|
|
136198
|
+
* When the recording started, ISO 8601 UTC, on the server clock.
|
|
136199
|
+
*/
|
|
136200
|
+
startedAt: string
|
|
136201
|
+
/**
|
|
136202
|
+
* utm_medium of the entry page. Null when untagged.
|
|
136203
|
+
*/
|
|
136204
|
+
utmMedium: (string | null)
|
|
136205
|
+
/**
|
|
136206
|
+
* utm_source of the entry page. Null when untagged.
|
|
136207
|
+
*/
|
|
136208
|
+
utmSource: (string | null)
|
|
136209
|
+
/**
|
|
136210
|
+
* Length of the recording in milliseconds.
|
|
136211
|
+
*/
|
|
136212
|
+
durationMs: number
|
|
136213
|
+
/**
|
|
136214
|
+
* Ad network of the click that opened the session: gclid for Google Ads, fbclid for Meta. Null for a non-ad arrival.
|
|
136215
|
+
*/
|
|
136216
|
+
clickIdType: (string | null)
|
|
136217
|
+
/**
|
|
136218
|
+
* utm_campaign of the entry page. Null when untagged.
|
|
136219
|
+
*/
|
|
136220
|
+
utmCampaign: (string | null)
|
|
136221
|
+
/**
|
|
136222
|
+
* Page loads (and consent re-starts) recorded in the session.
|
|
136223
|
+
*/
|
|
136224
|
+
segmentCount: number
|
|
136225
|
+
}[]
|
|
136226
|
+
/**
|
|
136227
|
+
* Pass back as cursor for the next page. Null on the last page.
|
|
136228
|
+
*/
|
|
136229
|
+
nextCursor: (string | null)
|
|
136230
|
+
}
|
|
136231
|
+
|
|
135889
136232
|
export interface TrackingReportsAttributedJourneyInput {
|
|
135890
136233
|
/**
|
|
135891
136234
|
* Show only journey events at or before this instant (ISO). Omit for the whole history.
|