@lessly/sdk-app 103.0.0 → 104.0.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 +10 -32
- package/dist/_types/gen/client.gen.d.ts +49 -1
- package/dist/_types/gen/manifest.gen.d.ts +1 -1
- package/dist/_types/gen/playground/connect.gen.d.ts +3 -0
- package/dist/_types/gen/playground/index.d.ts +3 -0
- package/dist/_types/gen/playground/queryOptions.gen.d.ts +70 -0
- package/dist/_types/gen/tracking/index.d.ts +1 -1
- package/dist/_types/gen/tracking/queryOptions.gen.d.ts +21 -1
- package/dist/_types/gen/types.gen.d.ts +699 -10
- package/dist/chunk-FSDRL4AE.js +12083 -0
- package/dist/chunk-FSDRL4AE.js.map +1 -0
- package/dist/index.cjs +359 -46
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +32 -11788
- package/dist/index.js.map +1 -1
- package/dist/playground/index.cjs +106 -0
- package/dist/playground/index.cjs.map +1 -0
- package/dist/playground/index.d.cts +1 -0
- package/dist/playground/index.d.ts +1 -0
- package/dist/playground/index.js +78 -0
- package/dist/playground/index.js.map +1 -0
- package/dist/tracking/index.cjs +25 -0
- package/dist/tracking/index.cjs.map +1 -1
- package/dist/tracking/index.js +21 -1
- package/dist/tracking/index.js.map +1 -1
- package/package.json +12 -2
- package/src/gen/bindings.gen.ts +338 -46
- package/src/gen/client.gen.ts +92 -0
- package/src/gen/manifest.gen.ts +31 -2
- package/src/gen/playground/connect.gen.ts +9 -0
- package/src/gen/playground/index.ts +4 -0
- package/src/gen/playground/queryOptions.gen.ts +119 -0
- package/src/gen/tracking/index.ts +1 -1
- package/src/gen/tracking/queryOptions.gen.ts +34 -0
- package/src/gen/types.gen.ts +756 -10
package/src/gen/types.gen.ts
CHANGED
|
@@ -30,12 +30,6 @@ propertiesColumn: (string | null)
|
|
|
30
30
|
}[]
|
|
31
31
|
product_id: string
|
|
32
32
|
generated_at: string
|
|
33
|
-
dropped_metrics?: {
|
|
34
|
-
type: string
|
|
35
|
-
metric: string
|
|
36
|
-
reason: ("type_unknown" | "aggregate_unknown" | "column_missing")
|
|
37
|
-
view_name: string
|
|
38
|
-
}[]
|
|
39
33
|
}
|
|
40
34
|
|
|
41
35
|
export interface AnalyticsDashboardCreateInput {
|
|
@@ -111665,6 +111659,378 @@ export interface OrganizationYoutubeInstallOutput {
|
|
|
111665
111659
|
url: string
|
|
111666
111660
|
}
|
|
111667
111661
|
|
|
111662
|
+
export interface PlaygroundAnalyticsOverviewInput {
|
|
111663
|
+
/**
|
|
111664
|
+
* Max records per entity in recent[]; omit for the endpoint default
|
|
111665
|
+
*/
|
|
111666
|
+
limit?: number
|
|
111667
|
+
}
|
|
111668
|
+
|
|
111669
|
+
export interface PlaygroundAnalyticsOverviewOutput {
|
|
111670
|
+
ok: boolean
|
|
111671
|
+
minted: boolean
|
|
111672
|
+
overview?: unknown
|
|
111673
|
+
http_status: number
|
|
111674
|
+
}
|
|
111675
|
+
|
|
111676
|
+
export interface PlaygroundBillingEntitlementsInput {
|
|
111677
|
+
|
|
111678
|
+
}
|
|
111679
|
+
|
|
111680
|
+
export interface PlaygroundBillingEntitlementsOutput {
|
|
111681
|
+
ok: boolean
|
|
111682
|
+
minted: boolean
|
|
111683
|
+
http_status: number
|
|
111684
|
+
entitlements?: unknown
|
|
111685
|
+
}
|
|
111686
|
+
|
|
111687
|
+
export interface PlaygroundBillingRecordUsageInput {
|
|
111688
|
+
/**
|
|
111689
|
+
* Quantity of events to record against playground-events (SUM); defaults to 1
|
|
111690
|
+
*/
|
|
111691
|
+
value?: number
|
|
111692
|
+
}
|
|
111693
|
+
|
|
111694
|
+
export interface PlaygroundBillingRecordUsageOutput {
|
|
111695
|
+
minted: boolean
|
|
111696
|
+
accepted: (number | null)
|
|
111697
|
+
recorded: boolean
|
|
111698
|
+
duplicates: (number | null)
|
|
111699
|
+
http_status: number
|
|
111700
|
+
}
|
|
111701
|
+
|
|
111702
|
+
export interface PlaygroundClickupCreateTaskInput {
|
|
111703
|
+
/**
|
|
111704
|
+
* Task title; defaults to a fixture label
|
|
111705
|
+
*/
|
|
111706
|
+
name?: string
|
|
111707
|
+
/**
|
|
111708
|
+
* ClickUp list id; falls back to CLICKUP_TEST_LIST_ID
|
|
111709
|
+
*/
|
|
111710
|
+
listId?: string
|
|
111711
|
+
}
|
|
111712
|
+
|
|
111713
|
+
export interface PlaygroundClickupCreateTaskOutput {
|
|
111714
|
+
minted: boolean
|
|
111715
|
+
task_id: (string | null)
|
|
111716
|
+
list_status: number
|
|
111717
|
+
vend_status: number
|
|
111718
|
+
clickup_status: number
|
|
111719
|
+
installation_count: number
|
|
111720
|
+
}
|
|
111721
|
+
|
|
111722
|
+
export interface PlaygroundClickupGetLastWebhookInput {
|
|
111723
|
+
|
|
111724
|
+
}
|
|
111725
|
+
|
|
111726
|
+
export type PlaygroundClickupGetLastWebhookOutput = ({
|
|
111727
|
+
payload: string
|
|
111728
|
+
event_id: string
|
|
111729
|
+
provider: string
|
|
111730
|
+
verified: boolean
|
|
111731
|
+
product_id: string
|
|
111732
|
+
occurred_at: string
|
|
111733
|
+
connector_id: string
|
|
111734
|
+
clickup_event: (string | null)
|
|
111735
|
+
receipt_count: number
|
|
111736
|
+
} | {
|
|
111737
|
+
found: false
|
|
111738
|
+
})
|
|
111739
|
+
|
|
111740
|
+
export interface PlaygroundClickupGetOverviewInput {
|
|
111741
|
+
|
|
111742
|
+
}
|
|
111743
|
+
|
|
111744
|
+
export interface PlaygroundClickupGetOverviewOutput {
|
|
111745
|
+
team: ({
|
|
111746
|
+
teamId: string
|
|
111747
|
+
teamName: string
|
|
111748
|
+
} | null)
|
|
111749
|
+
lists: PlaygroundClickupGetOverviewOutputItems[]
|
|
111750
|
+
tasks: {
|
|
111751
|
+
id: string
|
|
111752
|
+
name: string
|
|
111753
|
+
status: (string | null)
|
|
111754
|
+
}[]
|
|
111755
|
+
minted: boolean
|
|
111756
|
+
spaces: PlaygroundClickupGetOverviewOutputItems[]
|
|
111757
|
+
list_status: number
|
|
111758
|
+
vend_status: number
|
|
111759
|
+
lists_status: number
|
|
111760
|
+
tasks_status: number
|
|
111761
|
+
spaces_status: number
|
|
111762
|
+
folders_status: number
|
|
111763
|
+
installation_count: number
|
|
111764
|
+
}
|
|
111765
|
+
export interface PlaygroundClickupGetOverviewOutputItems {
|
|
111766
|
+
id: string
|
|
111767
|
+
name: string
|
|
111768
|
+
}
|
|
111769
|
+
|
|
111770
|
+
export interface PlaygroundEchoPingInput {
|
|
111771
|
+
/**
|
|
111772
|
+
* The text to echo back, 1–1024 characters
|
|
111773
|
+
*/
|
|
111774
|
+
message: string
|
|
111775
|
+
}
|
|
111776
|
+
|
|
111777
|
+
export interface PlaygroundEchoPingOutput {
|
|
111778
|
+
/**
|
|
111779
|
+
* The message exactly as it was received
|
|
111780
|
+
*/
|
|
111781
|
+
message: string
|
|
111782
|
+
/**
|
|
111783
|
+
* The product the call was resolved to
|
|
111784
|
+
*/
|
|
111785
|
+
productId: string
|
|
111786
|
+
/**
|
|
111787
|
+
* ISO-8601 instant (UTC) at which the call reached the service
|
|
111788
|
+
*/
|
|
111789
|
+
receivedAt: string
|
|
111790
|
+
}
|
|
111791
|
+
|
|
111792
|
+
export interface PlaygroundGdriveGetLastChangeInput {
|
|
111793
|
+
|
|
111794
|
+
}
|
|
111795
|
+
|
|
111796
|
+
export type PlaygroundGdriveGetLastChangeOutput = ({
|
|
111797
|
+
file_id: string
|
|
111798
|
+
removed: boolean
|
|
111799
|
+
file_name: (string | null)
|
|
111800
|
+
mime_type: (string | null)
|
|
111801
|
+
product_id: string
|
|
111802
|
+
occurred_at: string
|
|
111803
|
+
connector_id: string
|
|
111804
|
+
resource_state: string
|
|
111805
|
+
} | {
|
|
111806
|
+
found: false
|
|
111807
|
+
})
|
|
111808
|
+
|
|
111809
|
+
export interface PlaygroundGdriveReadFileInput {
|
|
111810
|
+
/**
|
|
111811
|
+
* Drive file id; falls back to GDRIVE_TEST_FILE_ID, then the first picked file
|
|
111812
|
+
*/
|
|
111813
|
+
fileId?: string
|
|
111814
|
+
}
|
|
111815
|
+
|
|
111816
|
+
export interface PlaygroundGdriveReadFileOutput {
|
|
111817
|
+
minted: boolean
|
|
111818
|
+
file_id: (string | null)
|
|
111819
|
+
file_name: (string | null)
|
|
111820
|
+
mime_type: (string | null)
|
|
111821
|
+
file_count: number
|
|
111822
|
+
get_status: number
|
|
111823
|
+
list_status: number
|
|
111824
|
+
vend_status: number
|
|
111825
|
+
content_bytes: (number | null)
|
|
111826
|
+
}
|
|
111827
|
+
|
|
111828
|
+
export interface PlaygroundGoogleadsReadCustomerInput {
|
|
111829
|
+
|
|
111830
|
+
}
|
|
111831
|
+
|
|
111832
|
+
export interface PlaygroundGoogleadsReadCustomerOutput {
|
|
111833
|
+
minted: boolean
|
|
111834
|
+
vended: boolean
|
|
111835
|
+
customer_id: (string | null)
|
|
111836
|
+
vend_status: number
|
|
111837
|
+
result_count: number
|
|
111838
|
+
search_status: number
|
|
111839
|
+
login_customer_id: (string | null)
|
|
111840
|
+
}
|
|
111841
|
+
|
|
111842
|
+
export interface PlaygroundLifecycleGetStateInput {
|
|
111843
|
+
|
|
111844
|
+
}
|
|
111845
|
+
|
|
111846
|
+
export interface PlaygroundLifecycleGetStateOutput {
|
|
111847
|
+
blocked: boolean
|
|
111848
|
+
archived: boolean
|
|
111849
|
+
productId: string
|
|
111850
|
+
lastBlockTransition: ({
|
|
111851
|
+
eventId: string
|
|
111852
|
+
eventName: string
|
|
111853
|
+
productId: string
|
|
111854
|
+
occurredAt: string
|
|
111855
|
+
recordedAt: string
|
|
111856
|
+
receiptCount: number
|
|
111857
|
+
organizationId: string
|
|
111858
|
+
cascadedFromOrg: boolean
|
|
111859
|
+
} | null)
|
|
111860
|
+
lastArchiveTransition: ({
|
|
111861
|
+
eventId: string
|
|
111862
|
+
eventName: string
|
|
111863
|
+
productId: string
|
|
111864
|
+
occurredAt: string
|
|
111865
|
+
recordedAt: string
|
|
111866
|
+
receiptCount: number
|
|
111867
|
+
organizationId: string
|
|
111868
|
+
cascadedFromOrg: boolean
|
|
111869
|
+
} | null)
|
|
111870
|
+
}
|
|
111871
|
+
|
|
111872
|
+
export interface PlaygroundLifecycleListEventsInput {
|
|
111873
|
+
|
|
111874
|
+
}
|
|
111875
|
+
|
|
111876
|
+
export type PlaygroundLifecycleListEventsOutput = {
|
|
111877
|
+
eventId: string
|
|
111878
|
+
eventName: string
|
|
111879
|
+
productId: string
|
|
111880
|
+
occurredAt: string
|
|
111881
|
+
recordedAt: string
|
|
111882
|
+
receiptCount: number
|
|
111883
|
+
organizationId: string
|
|
111884
|
+
cascadedFromOrg: boolean
|
|
111885
|
+
}[]
|
|
111886
|
+
|
|
111887
|
+
export interface PlaygroundWebhookGetLastInput {
|
|
111888
|
+
|
|
111889
|
+
}
|
|
111890
|
+
|
|
111891
|
+
export type PlaygroundWebhookGetLastOutput = ({
|
|
111892
|
+
payload?: unknown
|
|
111893
|
+
event_id: string
|
|
111894
|
+
provider: string
|
|
111895
|
+
verified: boolean
|
|
111896
|
+
product_id: string
|
|
111897
|
+
occurred_at: string
|
|
111898
|
+
connector_id: string
|
|
111899
|
+
delivery_count: number
|
|
111900
|
+
} | {
|
|
111901
|
+
found: false
|
|
111902
|
+
})
|
|
111903
|
+
|
|
111904
|
+
export interface PlaygroundWorkflowEchoInput {
|
|
111905
|
+
/**
|
|
111906
|
+
* The text to store, 1–1024 characters
|
|
111907
|
+
*/
|
|
111908
|
+
note: string
|
|
111909
|
+
/**
|
|
111910
|
+
* Optional labels stored alongside the note, at most 20
|
|
111911
|
+
*
|
|
111912
|
+
* @maxItems 20
|
|
111913
|
+
*/
|
|
111914
|
+
tags?: []|[string]|[string, string]|[string, string, string]|[string, string, string, string]|[string, string, string, string, string]|[string, string, string, string, string, string]|[string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]|[string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string, string]
|
|
111915
|
+
}
|
|
111916
|
+
|
|
111917
|
+
export interface PlaygroundWorkflowEchoOutput {
|
|
111918
|
+
/**
|
|
111919
|
+
* Identifier of the stored echo
|
|
111920
|
+
*/
|
|
111921
|
+
id: string
|
|
111922
|
+
/**
|
|
111923
|
+
* The note exactly as it was received
|
|
111924
|
+
*/
|
|
111925
|
+
note: string
|
|
111926
|
+
/**
|
|
111927
|
+
* The tags exactly as they were received
|
|
111928
|
+
*/
|
|
111929
|
+
tags: string[]
|
|
111930
|
+
/**
|
|
111931
|
+
* Correlation id for this echo. The playground/workflow.echoed event published about two seconds later repeats it, which is how a composer matches the completion back to this step.
|
|
111932
|
+
*/
|
|
111933
|
+
echo_id: string
|
|
111934
|
+
/**
|
|
111935
|
+
* ISO-8601 instant (UTC) at which the echo was stored
|
|
111936
|
+
*/
|
|
111937
|
+
received_at: string
|
|
111938
|
+
}
|
|
111939
|
+
|
|
111940
|
+
export interface PlaygroundWorkflowEchoListInput {
|
|
111941
|
+
|
|
111942
|
+
}
|
|
111943
|
+
|
|
111944
|
+
export type PlaygroundWorkflowEchoListOutput = {
|
|
111945
|
+
/**
|
|
111946
|
+
* Identifier of the stored echo
|
|
111947
|
+
*/
|
|
111948
|
+
id: string
|
|
111949
|
+
/**
|
|
111950
|
+
* The note exactly as it was received
|
|
111951
|
+
*/
|
|
111952
|
+
note: string
|
|
111953
|
+
/**
|
|
111954
|
+
* The tags exactly as they were received
|
|
111955
|
+
*/
|
|
111956
|
+
tags: string[]
|
|
111957
|
+
/**
|
|
111958
|
+
* ISO-8601 instant (UTC) at which the echo was stored
|
|
111959
|
+
*/
|
|
111960
|
+
received_at: string
|
|
111961
|
+
}[]
|
|
111962
|
+
|
|
111963
|
+
export interface PlaygroundWorkflowPingInput {
|
|
111964
|
+
/**
|
|
111965
|
+
* Class of ping, echoed on the emitted event and filterable on the trigger. Defaults to 'manual'.
|
|
111966
|
+
*/
|
|
111967
|
+
kind?: string
|
|
111968
|
+
}
|
|
111969
|
+
|
|
111970
|
+
export interface PlaygroundWorkflowPingOutput {
|
|
111971
|
+
/**
|
|
111972
|
+
* Correlation id for this ping. The emitted playground/workflow.ping event repeats it, which is how a composer matches the event back to this step.
|
|
111973
|
+
*/
|
|
111974
|
+
id: string
|
|
111975
|
+
/**
|
|
111976
|
+
* The name of the event that was published
|
|
111977
|
+
*/
|
|
111978
|
+
event: string
|
|
111979
|
+
}
|
|
111980
|
+
|
|
111981
|
+
export interface PlaygroundWorkflowSubjectsListInput {
|
|
111982
|
+
/**
|
|
111983
|
+
* How many subjects to return, 1–100. Defaults to 25.
|
|
111984
|
+
*/
|
|
111985
|
+
limit?: number
|
|
111986
|
+
/**
|
|
111987
|
+
* The next_cursor of the previous page. Opaque — pass it back unchanged. Omit for the first page.
|
|
111988
|
+
*/
|
|
111989
|
+
cursor?: string
|
|
111990
|
+
/**
|
|
111991
|
+
* ISO-8601 UTC instant. Return only subjects whose last_activity_at is AT OR AFTER this — the opposite question, the recently active population. Omit for no lower bound.
|
|
111992
|
+
*/
|
|
111993
|
+
last_activity_after?: string
|
|
111994
|
+
/**
|
|
111995
|
+
* ISO-8601 UTC instant. Return only subjects whose last_activity_at is AT OR BEFORE this — the "inactive for N days" question: pass now minus N days. Omit for no upper bound.
|
|
111996
|
+
*/
|
|
111997
|
+
last_activity_before?: string
|
|
111998
|
+
}
|
|
111999
|
+
|
|
112000
|
+
export interface PlaygroundWorkflowSubjectsListOutput {
|
|
112001
|
+
/**
|
|
112002
|
+
* This page of subjects, most recently active first
|
|
112003
|
+
*/
|
|
112004
|
+
items: {
|
|
112005
|
+
/**
|
|
112006
|
+
* Stable identifier for the subject. This is the field a batch trigger keys on, so a subject already served in an earlier run is skipped rather than served twice.
|
|
112007
|
+
*/
|
|
112008
|
+
subject_key: string
|
|
112009
|
+
/**
|
|
112010
|
+
* Human-readable name of the subject
|
|
112011
|
+
*/
|
|
112012
|
+
display_name: string
|
|
112013
|
+
/**
|
|
112014
|
+
* ISO-8601 instant (UTC) of the subject last activity
|
|
112015
|
+
*/
|
|
112016
|
+
last_activity_at: string
|
|
112017
|
+
}[]
|
|
112018
|
+
/**
|
|
112019
|
+
* Whether another page follows. False and a null next_cursor both mark the last page, so a consumer that loops on either terminates.
|
|
112020
|
+
*/
|
|
112021
|
+
has_more: boolean
|
|
112022
|
+
/**
|
|
112023
|
+
* Pass back as `cursor` to fetch the next page; null on the last page. Always null when has_more is false.
|
|
112024
|
+
*/
|
|
112025
|
+
next_cursor: (string | null)
|
|
112026
|
+
}
|
|
112027
|
+
|
|
112028
|
+
export interface PlaygroundWsEchoInput {
|
|
112029
|
+
|
|
112030
|
+
}
|
|
112031
|
+
|
|
112032
|
+
export type PlaygroundWsEchoOutput = unknown;
|
|
112033
|
+
|
|
111668
112034
|
export interface RealtimeArchiveExportInput {
|
|
111669
112035
|
/**
|
|
111670
112036
|
* Only entries with ts <= to_ts (epoch ms)
|
|
@@ -133662,7 +134028,7 @@ export interface TrackingEntitlementDropsGetInput {
|
|
|
133662
134028
|
|
|
133663
134029
|
export interface TrackingEntitlementDropsGetOutput {
|
|
133664
134030
|
/**
|
|
133665
|
-
* Null when no event was refused this month.
|
|
134031
|
+
* Null when no event and no session recording was refused this month.
|
|
133666
134032
|
*/
|
|
133667
134033
|
drops: ({
|
|
133668
134034
|
/**
|
|
@@ -133693,6 +134059,10 @@ droppedBatches: number
|
|
|
133693
134059
|
* First refused flush this month, ISO 8601 UTC.
|
|
133694
134060
|
*/
|
|
133695
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
|
|
133696
134066
|
} | null)
|
|
133697
134067
|
/**
|
|
133698
134068
|
* First day of the current UTC month the figures cover, YYYY-MM-DD, e.g. 2026-09-01.
|
|
@@ -134934,7 +135304,7 @@ utmCampaign: (string | null)
|
|
|
134934
135304
|
*/
|
|
134935
135305
|
country: (string | null)
|
|
134936
135306
|
/**
|
|
134937
|
-
*
|
|
135307
|
+
* Shortened event anonymous id. From the rollout, keyed cookieless events carry d:<daily key>: a one-day visitor rotating every UTC midnight, never a toolkit profile. They appear in funnels, person counts and retention as separate people each day; filter consent_statistics = true for consented-only figures and always for retention. Null when no id or daily key is available.
|
|
134938
135308
|
*/
|
|
134939
135309
|
anonymousId: (string | null)
|
|
134940
135310
|
}[]
|
|
@@ -134994,6 +135364,32 @@ profileId: string
|
|
|
134994
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.
|
|
134995
135365
|
*/
|
|
134996
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
|
+
}
|
|
134997
135393
|
}
|
|
134998
135394
|
|
|
134999
135395
|
export interface TrackingProfilesExportInput {
|
|
@@ -135483,6 +135879,356 @@ firstSeenAt: string
|
|
|
135483
135879
|
}[]
|
|
135484
135880
|
}
|
|
135485
135881
|
|
|
135882
|
+
export interface TrackingRecordingSettingsGetInput {
|
|
135883
|
+
|
|
135884
|
+
}
|
|
135885
|
+
|
|
135886
|
+
export interface TrackingRecordingSettingsGetOutput {
|
|
135887
|
+
/**
|
|
135888
|
+
* Whether session recording is on. Only visitors in full tracking mode (statistics consent, or no consent banner) are recorded.
|
|
135889
|
+
*/
|
|
135890
|
+
enabled: boolean
|
|
135891
|
+
/**
|
|
135892
|
+
* Percent of sessions recorded, 1 to 100 when on (e.g. 25); 0 is allowed only when off.
|
|
135893
|
+
*/
|
|
135894
|
+
sampleRate: number
|
|
135895
|
+
}
|
|
135896
|
+
|
|
135897
|
+
export interface TrackingRecordingSettingsSetInput {
|
|
135898
|
+
/**
|
|
135899
|
+
* Whether session recording is on. Only visitors in full tracking mode (statistics consent, or no consent banner) are recorded.
|
|
135900
|
+
*/
|
|
135901
|
+
enabled: boolean
|
|
135902
|
+
/**
|
|
135903
|
+
* Percent of sessions recorded, 1 to 100 when on (e.g. 25); 0 is allowed only when off.
|
|
135904
|
+
*/
|
|
135905
|
+
sampleRate: number
|
|
135906
|
+
}
|
|
135907
|
+
|
|
135908
|
+
export interface TrackingRecordingSettingsSetOutput {
|
|
135909
|
+
/**
|
|
135910
|
+
* Whether session recording is on. Only visitors in full tracking mode (statistics consent, or no consent banner) are recorded.
|
|
135911
|
+
*/
|
|
135912
|
+
enabled: boolean
|
|
135913
|
+
/**
|
|
135914
|
+
* Percent of sessions recorded, 1 to 100 when on (e.g. 25); 0 is allowed only when off.
|
|
135915
|
+
*/
|
|
135916
|
+
sampleRate: number
|
|
135917
|
+
}
|
|
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
|
+
|
|
135486
136232
|
export interface TrackingReportsAttributedJourneyInput {
|
|
135487
136233
|
/**
|
|
135488
136234
|
* Show only journey events at or before this instant (ISO). Omit for the whole history.
|
|
@@ -135735,11 +136481,11 @@ utcDaysInRange: number
|
|
|
135735
136481
|
*/
|
|
135736
136482
|
cookielessShare: number
|
|
135737
136483
|
/**
|
|
135738
|
-
* Events from visitors who declined
|
|
136484
|
+
* Events from visitors who declined or had not decided; the browser sent no identifier, though ingest may derive a one-day d: id.
|
|
135739
136485
|
*/
|
|
135740
136486
|
cookielessEvents: number
|
|
135741
136487
|
/**
|
|
135742
|
-
* Events
|
|
136488
|
+
* Events with a non-cookieless anonymous id (granted or no-banner). Cookieless d: ids are excluded. This quality slice overlaps the consent buckets and must not be added to them.
|
|
135743
136489
|
*/
|
|
135744
136490
|
identifiedEvents: number
|
|
135745
136491
|
/**
|