@clikgate/node 2.0.0 → 2.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 +35 -0
- package/README.md +126 -6
- package/SECURITY.md +2 -1
- package/dist/cjs/client.d.ts +54 -10
- package/dist/cjs/client.js +75 -16
- package/dist/cjs/currency.d.ts +7 -0
- package/dist/cjs/currency.js +75 -0
- package/dist/cjs/customer-id.d.ts +26 -0
- package/dist/cjs/customer-id.js +52 -0
- package/dist/cjs/enums.js +1 -1
- package/dist/cjs/errors.d.ts +1 -1
- package/dist/cjs/event-types.d.ts +108 -0
- package/dist/cjs/event-types.js +109 -0
- package/dist/cjs/express.d.ts +11 -2
- package/dist/cjs/express.js +3 -2
- package/dist/cjs/fastify.d.ts +4 -1
- package/dist/cjs/fastify.js +3 -2
- package/dist/cjs/generated/index.d.ts +2015 -83
- package/dist/cjs/generated/index.js +83 -3
- package/dist/cjs/identity.d.ts +12 -2
- package/dist/cjs/identity.js +37 -3
- package/dist/cjs/index.d.ts +11 -1
- package/dist/cjs/index.js +21 -1
- package/dist/cjs/installation.d.ts +47 -0
- package/dist/cjs/installation.js +83 -0
- package/dist/cjs/known-customers.d.ts +45 -0
- package/dist/cjs/known-customers.js +95 -0
- package/dist/cjs/lookups.d.ts +128 -0
- package/dist/cjs/lookups.js +149 -0
- package/dist/cjs/models.d.ts +342 -0
- package/dist/cjs/models.js +2 -0
- package/dist/cjs/next.d.ts +22 -0
- package/dist/cjs/next.js +20 -0
- package/dist/cjs/pager.d.ts +5 -0
- package/dist/cjs/pager.js +40 -0
- package/dist/cjs/referrals.d.ts +169 -0
- package/dist/cjs/referrals.js +208 -0
- package/dist/cjs/resources.d.ts +34 -5
- package/dist/cjs/resources.js +43 -42
- package/dist/cjs/types.d.ts +57 -10
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/webhooks.d.ts +3 -2
- package/dist/cjs/webhooks.js +43 -2
- package/dist/esm/client.d.ts +54 -10
- package/dist/esm/client.js +75 -16
- package/dist/esm/currency.d.ts +7 -0
- package/dist/esm/currency.js +67 -0
- package/dist/esm/customer-id.d.ts +26 -0
- package/dist/esm/customer-id.js +47 -0
- package/dist/esm/enums.js +1 -1
- package/dist/esm/errors.d.ts +1 -1
- package/dist/esm/event-types.d.ts +108 -0
- package/dist/esm/event-types.js +106 -0
- package/dist/esm/express.d.ts +11 -2
- package/dist/esm/express.js +3 -2
- package/dist/esm/fastify.d.ts +4 -1
- package/dist/esm/fastify.js +3 -2
- package/dist/esm/generated/index.d.ts +2015 -83
- package/dist/esm/generated/index.js +80 -1
- package/dist/esm/identity.d.ts +12 -2
- package/dist/esm/identity.js +36 -3
- package/dist/esm/index.d.ts +11 -1
- package/dist/esm/index.js +6 -0
- package/dist/esm/installation.d.ts +47 -0
- package/dist/esm/installation.js +77 -0
- package/dist/esm/known-customers.d.ts +45 -0
- package/dist/esm/known-customers.js +90 -0
- package/dist/esm/lookups.d.ts +128 -0
- package/dist/esm/lookups.js +142 -0
- package/dist/esm/models.d.ts +342 -0
- package/dist/esm/models.js +1 -0
- package/dist/esm/next.d.ts +22 -0
- package/dist/esm/next.js +19 -0
- package/dist/esm/pager.d.ts +5 -0
- package/dist/esm/pager.js +36 -0
- package/dist/esm/referrals.d.ts +169 -0
- package/dist/esm/referrals.js +204 -0
- package/dist/esm/resources.d.ts +34 -5
- package/dist/esm/resources.js +43 -42
- package/dist/esm/types.d.ts +57 -10
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/esm/webhooks.d.ts +3 -2
- package/dist/esm/webhooks.js +42 -2
- package/package.json +2 -2
|
@@ -13,6 +13,41 @@ export interface BinaryResponse {
|
|
|
13
13
|
contentType: string;
|
|
14
14
|
data: Uint8Array;
|
|
15
15
|
}
|
|
16
|
+
export interface AbTestLeader {
|
|
17
|
+
'id': string;
|
|
18
|
+
'name': string | null;
|
|
19
|
+
}
|
|
20
|
+
export interface AbTestLikelyWinnerEventData {
|
|
21
|
+
/**
|
|
22
|
+
* Always null for this event type.
|
|
23
|
+
*/
|
|
24
|
+
'previous_attributes': any | null;
|
|
25
|
+
'object': AbTestLikelyWinnerObject;
|
|
26
|
+
}
|
|
27
|
+
export interface AbTestLikelyWinnerObject {
|
|
28
|
+
'object': 'ab_test';
|
|
29
|
+
'id': string;
|
|
30
|
+
'name': string;
|
|
31
|
+
'link': AbTestLinkRef;
|
|
32
|
+
/**
|
|
33
|
+
* The version that is likely better.
|
|
34
|
+
*/
|
|
35
|
+
'leader': AbTestLeader | null;
|
|
36
|
+
'clicks': number;
|
|
37
|
+
'goals': number;
|
|
38
|
+
'detected_at': string;
|
|
39
|
+
/**
|
|
40
|
+
* true for live-environment data, false for test mode.
|
|
41
|
+
*/
|
|
42
|
+
'livemode': boolean;
|
|
43
|
+
}
|
|
44
|
+
export interface AbTestLinkRef {
|
|
45
|
+
'id': string;
|
|
46
|
+
/**
|
|
47
|
+
* The link's title, else its slug.
|
|
48
|
+
*/
|
|
49
|
+
'title': string;
|
|
50
|
+
}
|
|
16
51
|
export interface AcceptSuggestionResponse {
|
|
17
52
|
'object'?: 'goal_suggestion_accepted';
|
|
18
53
|
'applied': 'new_goal' | 'alias';
|
|
@@ -49,7 +84,7 @@ export interface ActivityGroup {
|
|
|
49
84
|
'totals': ActivityMetrics;
|
|
50
85
|
'previous': ActivityMetrics;
|
|
51
86
|
'change_pct': {
|
|
52
|
-
[key: string]:
|
|
87
|
+
[key: string]: ChangePctValue;
|
|
53
88
|
};
|
|
54
89
|
'series': Array<ActivityPoint>;
|
|
55
90
|
}
|
|
@@ -85,7 +120,7 @@ export interface ActivityPoint {
|
|
|
85
120
|
'start': string;
|
|
86
121
|
'end': string;
|
|
87
122
|
'change_pct': {
|
|
88
|
-
[key: string]:
|
|
123
|
+
[key: string]: ChangePctValue;
|
|
89
124
|
};
|
|
90
125
|
}
|
|
91
126
|
export interface AdAccountInfoResponse {
|
|
@@ -845,6 +880,13 @@ export interface AlertConditionSchema {
|
|
|
845
880
|
'baseline'?: AlertBaseline | null;
|
|
846
881
|
'currency'?: string | null;
|
|
847
882
|
}
|
|
883
|
+
export interface AlertEventData {
|
|
884
|
+
/**
|
|
885
|
+
* Always null for this event type.
|
|
886
|
+
*/
|
|
887
|
+
'previous_attributes': any | null;
|
|
888
|
+
'object': AlertInfoResponse;
|
|
889
|
+
}
|
|
848
890
|
export interface AlertInfoResponse {
|
|
849
891
|
'id': string;
|
|
850
892
|
'object'?: 'alert';
|
|
@@ -1103,7 +1145,7 @@ export interface AnalyticsRowResponse {
|
|
|
1103
1145
|
'app_open_label'?: 'estimated' | null;
|
|
1104
1146
|
'in_app_browser_share'?: number | null;
|
|
1105
1147
|
'change_pct'?: {
|
|
1106
|
-
[key: string]:
|
|
1148
|
+
[key: string]: ChangePctValue;
|
|
1107
1149
|
} | null;
|
|
1108
1150
|
'existing_app_users'?: number | null;
|
|
1109
1151
|
'people_without_app'?: number | null;
|
|
@@ -1203,7 +1245,7 @@ export interface AppActivityResponse {
|
|
|
1203
1245
|
'totals': ActivityMetrics;
|
|
1204
1246
|
'previous': ActivityMetrics;
|
|
1205
1247
|
'change_pct': {
|
|
1206
|
-
[key: string]:
|
|
1248
|
+
[key: string]: ChangePctValue;
|
|
1207
1249
|
};
|
|
1208
1250
|
'series': Array<ActivityPoint>;
|
|
1209
1251
|
'groups': Array<ActivityGroup>;
|
|
@@ -1235,6 +1277,13 @@ export interface AppBannerDisplaySchema {
|
|
|
1235
1277
|
'priority'?: number;
|
|
1236
1278
|
'measure_right_screen'?: boolean;
|
|
1237
1279
|
}
|
|
1280
|
+
export interface AppBannerEventData {
|
|
1281
|
+
/**
|
|
1282
|
+
* Always null for this event type.
|
|
1283
|
+
*/
|
|
1284
|
+
'previous_attributes': any | null;
|
|
1285
|
+
'object': AppBannerInfoResponse;
|
|
1286
|
+
}
|
|
1238
1287
|
export interface AppBannerInfoResponse {
|
|
1239
1288
|
'id': string;
|
|
1240
1289
|
'object'?: 'app_banner';
|
|
@@ -1447,6 +1496,22 @@ export interface AppPersonLabelSchema {
|
|
|
1447
1496
|
'label': string;
|
|
1448
1497
|
}
|
|
1449
1498
|
export type AppPlatform = 'ios' | 'android';
|
|
1499
|
+
export interface AppReengagedEventData {
|
|
1500
|
+
/**
|
|
1501
|
+
* Always null for this event type.
|
|
1502
|
+
*/
|
|
1503
|
+
'previous_attributes': any | null;
|
|
1504
|
+
'object': InstallInfoResponse;
|
|
1505
|
+
/**
|
|
1506
|
+
* The click that opened the app.
|
|
1507
|
+
*/
|
|
1508
|
+
'click_id': string;
|
|
1509
|
+
'link': InstallLinkResponse;
|
|
1510
|
+
/**
|
|
1511
|
+
* The install's previous app open (ISO 8601), if any.
|
|
1512
|
+
*/
|
|
1513
|
+
'previous_open_at': string | null;
|
|
1514
|
+
}
|
|
1450
1515
|
export interface AppleApiKeyInfo {
|
|
1451
1516
|
'client_id': string | null;
|
|
1452
1517
|
'team_id': string | null;
|
|
@@ -1857,6 +1922,17 @@ export interface CampaignPerformanceRow {
|
|
|
1857
1922
|
'uninstall_rate_d7'?: number | null;
|
|
1858
1923
|
'real_installs'?: number | null;
|
|
1859
1924
|
}
|
|
1925
|
+
export interface CampaignStatusEventData {
|
|
1926
|
+
/**
|
|
1927
|
+
* Always null for this event type.
|
|
1928
|
+
*/
|
|
1929
|
+
'previous_attributes': any | null;
|
|
1930
|
+
'object': CampaignInfoResponse;
|
|
1931
|
+
/**
|
|
1932
|
+
* How many links changed status.
|
|
1933
|
+
*/
|
|
1934
|
+
'affected_links': number;
|
|
1935
|
+
}
|
|
1860
1936
|
/**
|
|
1861
1937
|
* POST /v1/challenges/{id}/cancel: a reason is required once the challenge is live.
|
|
1862
1938
|
*/
|
|
@@ -1893,10 +1969,69 @@ export interface CertaintyResponse {
|
|
|
1893
1969
|
'estimated_low'?: number | null;
|
|
1894
1970
|
'estimated_high'?: number | null;
|
|
1895
1971
|
}
|
|
1972
|
+
export interface ChallengeCancelledEventData {
|
|
1973
|
+
/**
|
|
1974
|
+
* Always null for this event type.
|
|
1975
|
+
*/
|
|
1976
|
+
'previous_attributes': any | null;
|
|
1977
|
+
'object': ChallengeInfoResponse;
|
|
1978
|
+
'previous_status': string;
|
|
1979
|
+
'reason': string | null;
|
|
1980
|
+
}
|
|
1896
1981
|
export interface ChallengeCompareResponse {
|
|
1897
1982
|
'object'?: 'list';
|
|
1898
1983
|
'data': Array<ChallengeResultsResponse>;
|
|
1899
1984
|
}
|
|
1985
|
+
export interface ChallengeEndedEventData {
|
|
1986
|
+
/**
|
|
1987
|
+
* Always null for this event type.
|
|
1988
|
+
*/
|
|
1989
|
+
'previous_attributes': any | null;
|
|
1990
|
+
'object': ChallengeInfoResponse;
|
|
1991
|
+
/**
|
|
1992
|
+
* The trophy winners (empty without a trophy).
|
|
1993
|
+
*/
|
|
1994
|
+
'winners': Array<LeaderboardWinnerObject>;
|
|
1995
|
+
}
|
|
1996
|
+
export interface ChallengeEventData {
|
|
1997
|
+
/**
|
|
1998
|
+
* Always null for this event type.
|
|
1999
|
+
*/
|
|
2000
|
+
'previous_attributes': any | null;
|
|
2001
|
+
'object': ChallengeInfoResponse;
|
|
2002
|
+
}
|
|
2003
|
+
/**
|
|
2004
|
+
* The challenge's results as frozen when it became final.
|
|
2005
|
+
*/
|
|
2006
|
+
export interface ChallengeFinalResults {
|
|
2007
|
+
'challenge_id': string;
|
|
2008
|
+
'name': string;
|
|
2009
|
+
'status': string;
|
|
2010
|
+
'starts_at': string | null;
|
|
2011
|
+
'ends_at': string | null;
|
|
2012
|
+
'timezone': string;
|
|
2013
|
+
'final': boolean;
|
|
2014
|
+
'computed_at': string;
|
|
2015
|
+
'participants': number;
|
|
2016
|
+
'active_participants': number;
|
|
2017
|
+
'new_referees': number;
|
|
2018
|
+
'goals_completed': number | null;
|
|
2019
|
+
'total_value': Money | null;
|
|
2020
|
+
'winners': Array<LeaderboardWinnerObject>;
|
|
2021
|
+
'prize_cost': ChallengePrizeCostInfo | null;
|
|
2022
|
+
'cost_per_new_referee': Money | null;
|
|
2023
|
+
'cost_per_goal': Money | null;
|
|
2024
|
+
'post_final_changes': Array<LeaderboardPostFinalChange>;
|
|
2025
|
+
}
|
|
2026
|
+
export interface ChallengeFinalizedEventData {
|
|
2027
|
+
/**
|
|
2028
|
+
* Always null for this event type.
|
|
2029
|
+
*/
|
|
2030
|
+
'previous_attributes': any | null;
|
|
2031
|
+
'object': ChallengeInfoResponse;
|
|
2032
|
+
'winners': Array<LeaderboardWinnerObject>;
|
|
2033
|
+
'results': ChallengeFinalResults;
|
|
2034
|
+
}
|
|
1900
2035
|
export interface ChallengeInfoResponse {
|
|
1901
2036
|
'id': string;
|
|
1902
2037
|
'object'?: 'challenge';
|
|
@@ -1986,6 +2121,10 @@ export interface ChallengeParticipantResponse {
|
|
|
1986
2121
|
*/
|
|
1987
2122
|
'livemode': boolean;
|
|
1988
2123
|
}
|
|
2124
|
+
export interface ChallengePrizeCostInfo {
|
|
2125
|
+
'amount': string;
|
|
2126
|
+
'currency': string;
|
|
2127
|
+
}
|
|
1989
2128
|
export interface ChallengeResultsResponse {
|
|
1990
2129
|
'object'?: 'challenge_results';
|
|
1991
2130
|
'challenge_id': string;
|
|
@@ -2037,6 +2176,7 @@ export interface ChallengeTemplateResponse {
|
|
|
2037
2176
|
*/
|
|
2038
2177
|
'livemode': boolean;
|
|
2039
2178
|
}
|
|
2179
|
+
export type ChangePctValue = number;
|
|
2040
2180
|
/**
|
|
2041
2181
|
* The channel's new customers and spend split by campaign (the ad campaign first, else the Clikgate campaign).
|
|
2042
2182
|
*/
|
|
@@ -2107,6 +2247,39 @@ export interface ClickCampaignResponse {
|
|
|
2107
2247
|
'id': string;
|
|
2108
2248
|
'external_reference': string | null;
|
|
2109
2249
|
}
|
|
2250
|
+
export interface ClickCreatedEventData {
|
|
2251
|
+
/**
|
|
2252
|
+
* Always null for this event type.
|
|
2253
|
+
*/
|
|
2254
|
+
'previous_attributes': any | null;
|
|
2255
|
+
'object': ClickCreatedObject;
|
|
2256
|
+
}
|
|
2257
|
+
/**
|
|
2258
|
+
* A counted (non-bot) click. Never holds IP addresses or visitor hashes.
|
|
2259
|
+
*/
|
|
2260
|
+
export interface ClickCreatedObject {
|
|
2261
|
+
'object': 'click';
|
|
2262
|
+
'id': string;
|
|
2263
|
+
'link': ClickEventRef | null;
|
|
2264
|
+
'campaign': ClickEventRef | null;
|
|
2265
|
+
'post_tag_id': string | null;
|
|
2266
|
+
'variant_id': string | null;
|
|
2267
|
+
'channel': string | null;
|
|
2268
|
+
'country': string | null;
|
|
2269
|
+
'device_type': string | null;
|
|
2270
|
+
'is_qr': boolean;
|
|
2271
|
+
/**
|
|
2272
|
+
* When the click happened (ISO 8601).
|
|
2273
|
+
*/
|
|
2274
|
+
'occurred_at': string;
|
|
2275
|
+
/**
|
|
2276
|
+
* true for live-environment data, false for test mode.
|
|
2277
|
+
*/
|
|
2278
|
+
'livemode': boolean;
|
|
2279
|
+
}
|
|
2280
|
+
export interface ClickEventRef {
|
|
2281
|
+
'id': string;
|
|
2282
|
+
}
|
|
2110
2283
|
export interface ClickIdEngineRow {
|
|
2111
2284
|
'browser_engine': string;
|
|
2112
2285
|
'goals': number;
|
|
@@ -2275,13 +2448,21 @@ export interface CodeInfoResponse {
|
|
|
2275
2448
|
*/
|
|
2276
2449
|
'livemode': boolean;
|
|
2277
2450
|
}
|
|
2451
|
+
export interface CodeRedeemedEventData {
|
|
2452
|
+
/**
|
|
2453
|
+
* Always null for this event type.
|
|
2454
|
+
*/
|
|
2455
|
+
'previous_attributes': any | null;
|
|
2456
|
+
'object': OfflineTouchInfoResponse;
|
|
2457
|
+
}
|
|
2278
2458
|
export interface CodeRedemptionResponse {
|
|
2279
2459
|
'object'?: 'code_redemption';
|
|
2280
2460
|
'offline_touch_id': string;
|
|
2281
2461
|
'code': RedemptionCodeInfo;
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2462
|
+
/**
|
|
2463
|
+
* The referral this redemption created or found (referral codes whose subject maps to an install); null otherwise.
|
|
2464
|
+
*/
|
|
2465
|
+
'referral': ReferralInfoResponse | null;
|
|
2285
2466
|
'linked': boolean;
|
|
2286
2467
|
'referral_error'?: ReferralErrorInfo | null;
|
|
2287
2468
|
/**
|
|
@@ -2332,7 +2513,7 @@ export interface CohortMeasures {
|
|
|
2332
2513
|
/**
|
|
2333
2514
|
* Cumulative confirmed revenue by day 0-30 since install (the line chart); null after days_reached
|
|
2334
2515
|
*/
|
|
2335
|
-
'curve': Array<
|
|
2516
|
+
'curve': Array<CurveInner>;
|
|
2336
2517
|
'fx_estimated'?: boolean;
|
|
2337
2518
|
}
|
|
2338
2519
|
export interface CohortRevenueResponse {
|
|
@@ -2388,7 +2569,7 @@ export interface CohortRow {
|
|
|
2388
2569
|
/**
|
|
2389
2570
|
* Cumulative confirmed revenue by day 0-30 since install (the line chart); null after days_reached
|
|
2390
2571
|
*/
|
|
2391
|
-
'curve': Array<
|
|
2572
|
+
'curve': Array<CurveInner>;
|
|
2392
2573
|
'fx_estimated'?: boolean;
|
|
2393
2574
|
/**
|
|
2394
2575
|
* The cohort's first install day (Monday for weeks)
|
|
@@ -2595,6 +2776,17 @@ export interface ConversionDestinationInfoResponse {
|
|
|
2595
2776
|
*/
|
|
2596
2777
|
'livemode': boolean;
|
|
2597
2778
|
}
|
|
2779
|
+
export interface ConversionEventData {
|
|
2780
|
+
/**
|
|
2781
|
+
* Always null for this event type.
|
|
2782
|
+
*/
|
|
2783
|
+
'previous_attributes': any | null;
|
|
2784
|
+
'object': ConversionInfoResponse;
|
|
2785
|
+
/**
|
|
2786
|
+
* true when the event arrived before its click was recorded (a click served by the backup redirect during an outage) and was matched once the click appeared. Absent otherwise.
|
|
2787
|
+
*/
|
|
2788
|
+
'recorded_late'?: boolean | null;
|
|
2789
|
+
}
|
|
2598
2790
|
export interface ConversionInfoResponse {
|
|
2599
2791
|
'clicked_on'?: ClickedOn | null;
|
|
2600
2792
|
'clicked_on_basis'?: ClickedOnBasis | null;
|
|
@@ -2650,6 +2842,14 @@ export interface ConversionLinkResponse {
|
|
|
2650
2842
|
[key: string]: any;
|
|
2651
2843
|
};
|
|
2652
2844
|
}
|
|
2845
|
+
export interface ConversionReversedEventData {
|
|
2846
|
+
/**
|
|
2847
|
+
* Always null for this event type.
|
|
2848
|
+
*/
|
|
2849
|
+
'previous_attributes': any | null;
|
|
2850
|
+
'object': ConversionInfoResponse;
|
|
2851
|
+
'reversal': ReversalInfoResponse;
|
|
2852
|
+
}
|
|
2653
2853
|
export interface ConversionRuleInfo {
|
|
2654
2854
|
'id': string;
|
|
2655
2855
|
'name': string;
|
|
@@ -2776,6 +2976,11 @@ export interface CountGoalNameSchema {
|
|
|
2776
2976
|
* `once_per_click`: the first attributed event per (click, goal) counts; `every`: all count.
|
|
2777
2977
|
*/
|
|
2778
2978
|
export type CountMode = 'once_per_click' | 'every';
|
|
2979
|
+
export interface CountShare {
|
|
2980
|
+
'key': string;
|
|
2981
|
+
'count': number;
|
|
2982
|
+
'share': number;
|
|
2983
|
+
}
|
|
2779
2984
|
/**
|
|
2780
2985
|
* One-off export by email (`POST /v1/exports`). No recipients: the requesting member.
|
|
2781
2986
|
*/
|
|
@@ -2787,6 +2992,29 @@ export interface CreateExportSchema {
|
|
|
2787
2992
|
'to'?: string | null;
|
|
2788
2993
|
'recipients'?: ExportRecipientsSchema | null;
|
|
2789
2994
|
}
|
|
2995
|
+
export interface CreditNoteEventData {
|
|
2996
|
+
/**
|
|
2997
|
+
* Always null for this event type.
|
|
2998
|
+
*/
|
|
2999
|
+
'previous_attributes': any | null;
|
|
3000
|
+
'object': CreditNoteEventObject;
|
|
3001
|
+
}
|
|
3002
|
+
export interface CreditNoteEventObject {
|
|
3003
|
+
'object': 'credit_note';
|
|
3004
|
+
'id': string;
|
|
3005
|
+
'number': string;
|
|
3006
|
+
'invoice_id': string;
|
|
3007
|
+
'invoice_number': string | null;
|
|
3008
|
+
'currency': string;
|
|
3009
|
+
'amount_minor': number;
|
|
3010
|
+
'vat_minor': number;
|
|
3011
|
+
'issued_at': string;
|
|
3012
|
+
/**
|
|
3013
|
+
* true for live-environment data, false for test mode.
|
|
3014
|
+
*/
|
|
3015
|
+
'livemode': boolean;
|
|
3016
|
+
}
|
|
3017
|
+
export type CurveInner = number;
|
|
2790
3018
|
/**
|
|
2791
3019
|
* Average cumulative value per customer `day` days after their first day (day 0 = the first day).
|
|
2792
3020
|
*/
|
|
@@ -2806,7 +3034,7 @@ export interface CustomerCostBlended {
|
|
|
2806
3034
|
'customers_with_first_value': number;
|
|
2807
3035
|
'previous': CustomerCostPeriod | null;
|
|
2808
3036
|
'change_pct': number | null;
|
|
2809
|
-
'trend': Array<
|
|
3037
|
+
'trend': Array<TrendInner>;
|
|
2810
3038
|
'value': CustomerCostValue | null;
|
|
2811
3039
|
'value_reason': ValueReason | null;
|
|
2812
3040
|
'payback': CustomerCostPayback;
|
|
@@ -3019,6 +3247,7 @@ export interface DashboardListResponse {
|
|
|
3019
3247
|
'object'?: 'list';
|
|
3020
3248
|
'data': Array<DashboardInfoResponse>;
|
|
3021
3249
|
'home_dashboard_id': string | null;
|
|
3250
|
+
'sidebar_dashboard_ids'?: Array<string>;
|
|
3022
3251
|
'limit': number | null;
|
|
3023
3252
|
'sharing_included': boolean;
|
|
3024
3253
|
'logo_included': boolean;
|
|
@@ -3054,6 +3283,10 @@ export interface DashboardScheduleResponse {
|
|
|
3054
3283
|
'livemode': boolean;
|
|
3055
3284
|
}
|
|
3056
3285
|
export type DashboardTheme = 'light' | 'dark' | 'auto';
|
|
3286
|
+
/**
|
|
3287
|
+
* `data.object` and the event's extra keys; `type` says which schema applies (see `WebhookEvent`).
|
|
3288
|
+
*/
|
|
3289
|
+
export type Data = AbTestLikelyWinnerEventData | AlertEventData | AppBannerEventData | AppReengagedEventData | CampaignStatusEventData | ChallengeCancelledEventData | ChallengeEndedEventData | ChallengeEventData | ChallengeFinalizedEventData | ClickCreatedEventData | CodeRedeemedEventData | ConversionEventData | ConversionReversedEventData | CreditNoteEventData | DomainGroupChangedEventData | DomainSettingsUpdatedEventData | DomainStatusChangedEventData | FeatureChangeEventData | FeatureDataPurgeEventData | FraudInstallFlaggedEventData | FunnelStuckEventData | GoalCompletedEventData | GoalReversedEventData | IdentityDuplicateDetectedEventData | InstallAttributionUpdatedEventData | InstallEventData | InvoiceEventData | JobEventData | LeaderboardPeriodEventData | LeaderboardRankChangedEventData | LeaderboardTargetEventData | LinkCreatedEventData | LinkDestinationChangedEventData | LinkStatsHourlyEventData | LinkStatusEventData | LinkUpdatedEventData | OrganizationDeletedEventData | PartnerApprovedEventData | PartnerEarningApprovedEventData | PartnerPayoutPaidEventData | PartnerRewardEventData | PaymentEventData | PaymentRefundedEventData | PersonDeviceChangedEventData | PrivacyRequestEventData | PushCredentialsInvalidEventData | ReceiptEventData | ReferralEventData | ReferralStepCompletedEventData | ReferrerEventData | ReferrerQualityChangedEventData | SaleEventData | SaleRefundedEventData | SkanPostbackEventData | SubscriptionChangedEventData | SubscriptionEventData | SubscriptionUpdatedEventData | TrialEventData | UsageThresholdEventData | WebhookEndpointEventData | WebhookTestEventData | WhatsappConversationAttributedEventData;
|
|
3057
3290
|
export interface DataFeedInfoResponse {
|
|
3058
3291
|
'object'?: 'data_feed';
|
|
3059
3292
|
'id': string;
|
|
@@ -3188,11 +3421,43 @@ export interface DefaultDashboardsResponse {
|
|
|
3188
3421
|
[key: string]: string;
|
|
3189
3422
|
};
|
|
3190
3423
|
'redirects': Array<DefaultDashboardRedirect>;
|
|
3424
|
+
'focus'?: 'standard' | 'business' | 'creator' | 'partners' | 'links';
|
|
3425
|
+
'view'?: 'focused' | 'standard';
|
|
3191
3426
|
/**
|
|
3192
3427
|
* true for live-environment data, false for test mode.
|
|
3193
3428
|
*/
|
|
3194
3429
|
'livemode': boolean;
|
|
3195
3430
|
}
|
|
3431
|
+
/**
|
|
3432
|
+
* iOS first launches in the period and how the pasteboard step went. `match_rate` is `matched / attempted`
|
|
3433
|
+
* (`null` when nothing was attempted); never estimated.
|
|
3434
|
+
*/
|
|
3435
|
+
export interface DeferredMatchRateResponse {
|
|
3436
|
+
'platform'?: 'ios';
|
|
3437
|
+
/**
|
|
3438
|
+
* The app's `pasteboard_matching` is `on_interstitial_tap`
|
|
3439
|
+
*/
|
|
3440
|
+
'paste_flow_enabled': boolean;
|
|
3441
|
+
'period': MatchRatePeriodInfo;
|
|
3442
|
+
/**
|
|
3443
|
+
* iOS installs first opened in the period
|
|
3444
|
+
*/
|
|
3445
|
+
'first_launches': number;
|
|
3446
|
+
/**
|
|
3447
|
+
* First launches with a pasteboard outcome (the paste flow ran)
|
|
3448
|
+
*/
|
|
3449
|
+
'attempted': number;
|
|
3450
|
+
/**
|
|
3451
|
+
* Attempted first launches attributed with match type `pasteboard`
|
|
3452
|
+
*/
|
|
3453
|
+
'matched': number;
|
|
3454
|
+
/**
|
|
3455
|
+
* matched / attempted, 4 decimals; null when attempted is 0
|
|
3456
|
+
*/
|
|
3457
|
+
'match_rate': number | null;
|
|
3458
|
+
'outcomes': PasteboardOutcomeCounts;
|
|
3459
|
+
'other_matches': OtherMatchCounts;
|
|
3460
|
+
}
|
|
3196
3461
|
export interface DeleteIdentitySignalsResponse {
|
|
3197
3462
|
'object'?: 'identity_signals_deletion';
|
|
3198
3463
|
'subject': SubjectInfo;
|
|
@@ -3222,6 +3487,77 @@ export interface DestinationCheckResponse {
|
|
|
3222
3487
|
'livemode': boolean;
|
|
3223
3488
|
}
|
|
3224
3489
|
export type DestinationStatus = 'active' | 'paused' | 'error';
|
|
3490
|
+
export interface DeviceChangeResponse {
|
|
3491
|
+
'id': string;
|
|
3492
|
+
'app_id': string;
|
|
3493
|
+
'kind': 'switch' | 'second_device';
|
|
3494
|
+
'from_platform': string;
|
|
3495
|
+
'to_platform': string;
|
|
3496
|
+
'from_device_model': string | null;
|
|
3497
|
+
'to_device_model': string | null;
|
|
3498
|
+
'from_last_seen_at': string | null;
|
|
3499
|
+
'to_first_open_at': string;
|
|
3500
|
+
'gap_days': number | null;
|
|
3501
|
+
'created_at': string;
|
|
3502
|
+
}
|
|
3503
|
+
export interface DeviceChangeSide {
|
|
3504
|
+
'platform': string;
|
|
3505
|
+
'device_model': string | null;
|
|
3506
|
+
}
|
|
3507
|
+
/**
|
|
3508
|
+
* A customer moving to another phone, or adding one. Coarse device models only.
|
|
3509
|
+
*/
|
|
3510
|
+
export interface DeviceChangeWebhookObject {
|
|
3511
|
+
'object': 'device_change';
|
|
3512
|
+
/**
|
|
3513
|
+
* `{device_change_id}:{kind}`.
|
|
3514
|
+
*/
|
|
3515
|
+
'id': string;
|
|
3516
|
+
'device_change_id': string;
|
|
3517
|
+
'person_id': string;
|
|
3518
|
+
'customer_id': string | null;
|
|
3519
|
+
'app_id': string;
|
|
3520
|
+
/**
|
|
3521
|
+
* `switch` or `second_device`.
|
|
3522
|
+
*/
|
|
3523
|
+
'kind': string;
|
|
3524
|
+
'from': DeviceChangeSide;
|
|
3525
|
+
'to': DeviceChangeSide;
|
|
3526
|
+
/**
|
|
3527
|
+
* When the earlier phone was last seen (ISO 8601).
|
|
3528
|
+
*/
|
|
3529
|
+
'from_last_seen_at': string | null;
|
|
3530
|
+
/**
|
|
3531
|
+
* When the new phone first opened the app (ISO 8601).
|
|
3532
|
+
*/
|
|
3533
|
+
'to_first_open_at': string;
|
|
3534
|
+
/**
|
|
3535
|
+
* Days between the two, for a switch; null for a second device.
|
|
3536
|
+
*/
|
|
3537
|
+
'gap_days': number | null;
|
|
3538
|
+
/**
|
|
3539
|
+
* true for live-environment data, false for test mode.
|
|
3540
|
+
*/
|
|
3541
|
+
'livemode': boolean;
|
|
3542
|
+
}
|
|
3543
|
+
export interface DeviceChangesListResponse {
|
|
3544
|
+
'object'?: 'list';
|
|
3545
|
+
'data': Array<DeviceChangeResponse>;
|
|
3546
|
+
'locked'?: boolean;
|
|
3547
|
+
}
|
|
3548
|
+
export interface DeviceChangesReportResponse {
|
|
3549
|
+
'locked': boolean;
|
|
3550
|
+
'total': number;
|
|
3551
|
+
'lock_message'?: string | null;
|
|
3552
|
+
'months'?: Array<MonthCount>;
|
|
3553
|
+
'platform_moves'?: Array<CountShare>;
|
|
3554
|
+
'top_from_models'?: Array<CountShare>;
|
|
3555
|
+
'top_to_models'?: Array<CountShare>;
|
|
3556
|
+
'gap_days_median'?: number | null;
|
|
3557
|
+
'gap_days_distribution'?: Array<CountShare>;
|
|
3558
|
+
'phones_per_customer'?: Array<CountShare>;
|
|
3559
|
+
'old_phone_seen_again_share'?: number | null;
|
|
3560
|
+
}
|
|
3225
3561
|
/**
|
|
3226
3562
|
* An Apple key with DeviceCheck enabled (Certificates, Identifiers & Profiles > Keys).
|
|
3227
3563
|
*/
|
|
@@ -3281,6 +3617,13 @@ export interface DomainChecksResponse {
|
|
|
3281
3617
|
'authoritative'?: boolean;
|
|
3282
3618
|
'checked_at'?: string | null;
|
|
3283
3619
|
}
|
|
3620
|
+
export interface DomainGroupChangedEventData {
|
|
3621
|
+
'previous_attributes': DomainGroupPrevious;
|
|
3622
|
+
'object': DomainInfoResponse;
|
|
3623
|
+
'from_group_id': string;
|
|
3624
|
+
'to_group_id': string;
|
|
3625
|
+
'links_moved': number;
|
|
3626
|
+
}
|
|
3284
3627
|
/**
|
|
3285
3628
|
* Slugs used both by the domain's links and by the group: aliasing would make them ambiguous.
|
|
3286
3629
|
*/
|
|
@@ -3319,6 +3662,9 @@ export interface DomainGroupMemberResponse {
|
|
|
3319
3662
|
'mode': string;
|
|
3320
3663
|
'is_primary': boolean;
|
|
3321
3664
|
}
|
|
3665
|
+
export interface DomainGroupPrevious {
|
|
3666
|
+
'group_id': string;
|
|
3667
|
+
}
|
|
3322
3668
|
export interface DomainInfoResponse {
|
|
3323
3669
|
'id': string;
|
|
3324
3670
|
'object'?: 'domain';
|
|
@@ -3360,6 +3706,25 @@ export interface DomainInfoResponse {
|
|
|
3360
3706
|
* `short` (SMS, WhatsApp, creator links) or `branded` (email, ads); informational plus defaults.
|
|
3361
3707
|
*/
|
|
3362
3708
|
export type DomainRole = 'short' | 'branded';
|
|
3709
|
+
/**
|
|
3710
|
+
* The settings that changed, with their earlier values (only the changed keys are present).
|
|
3711
|
+
*/
|
|
3712
|
+
export interface DomainSettingsPrevious {
|
|
3713
|
+
'role'?: string | null;
|
|
3714
|
+
'root_redirect_url'?: string | null;
|
|
3715
|
+
'not_found_url'?: string | null;
|
|
3716
|
+
'unavailable_url'?: string | null;
|
|
3717
|
+
/**
|
|
3718
|
+
* The earlier branding: `logo_url`, `primary_color`, `display_name` when set.
|
|
3719
|
+
*/
|
|
3720
|
+
'branding'?: {
|
|
3721
|
+
[key: string]: any;
|
|
3722
|
+
} | null;
|
|
3723
|
+
}
|
|
3724
|
+
export interface DomainSettingsUpdatedEventData {
|
|
3725
|
+
'previous_attributes': DomainSettingsPrevious;
|
|
3726
|
+
'object': DomainInfoResponse;
|
|
3727
|
+
}
|
|
3363
3728
|
/**
|
|
3364
3729
|
* Step-by-step DNS instructions.
|
|
3365
3730
|
*/
|
|
@@ -3401,6 +3766,18 @@ export interface DomainSetupSendListResponse {
|
|
|
3401
3766
|
'object'?: 'list';
|
|
3402
3767
|
'data': Array<DomainSetupSendInfoResponse>;
|
|
3403
3768
|
}
|
|
3769
|
+
export interface DomainStatusChangedEventData {
|
|
3770
|
+
/**
|
|
3771
|
+
* Always null for this event type.
|
|
3772
|
+
*/
|
|
3773
|
+
'previous_attributes': any | null;
|
|
3774
|
+
'object': DomainInfoResponse;
|
|
3775
|
+
'previous_status': string;
|
|
3776
|
+
/**
|
|
3777
|
+
* Which check failed and what DNS returned.
|
|
3778
|
+
*/
|
|
3779
|
+
'checks': DomainChecksResponse | null;
|
|
3780
|
+
}
|
|
3404
3781
|
/**
|
|
3405
3782
|
* A ZIP of every active placement's QR code with an `index.csv` (number, name, URL, file).
|
|
3406
3783
|
*/
|
|
@@ -3585,9 +3962,7 @@ export interface EventInfoResponse {
|
|
|
3585
3962
|
'created_at': string;
|
|
3586
3963
|
'organization_id': string;
|
|
3587
3964
|
'livemode'?: boolean;
|
|
3588
|
-
'data':
|
|
3589
|
-
[key: string]: any;
|
|
3590
|
-
};
|
|
3965
|
+
'data': Data;
|
|
3591
3966
|
}
|
|
3592
3967
|
export interface EventMappingSchema {
|
|
3593
3968
|
'clikgate_event': string;
|
|
@@ -3678,8 +4053,8 @@ export interface ExploreRow {
|
|
|
3678
4053
|
/**
|
|
3679
4054
|
* One value per breakdown (ids; masked where private)
|
|
3680
4055
|
*/
|
|
3681
|
-
'keys': Array<
|
|
3682
|
-
'labels': Array<
|
|
4056
|
+
'keys': Array<KeysInner>;
|
|
4057
|
+
'labels': Array<KeysInner>;
|
|
3683
4058
|
/**
|
|
3684
4059
|
* Column id -> number (`null`: '—')
|
|
3685
4060
|
*/
|
|
@@ -3693,7 +4068,7 @@ export interface ExploreRow {
|
|
|
3693
4068
|
[key: string]: any;
|
|
3694
4069
|
} | null;
|
|
3695
4070
|
'change_pct'?: {
|
|
3696
|
-
[key: string]:
|
|
4071
|
+
[key: string]: ChangePctValue;
|
|
3697
4072
|
} | null;
|
|
3698
4073
|
}
|
|
3699
4074
|
export interface ExploreSortSchema {
|
|
@@ -3707,8 +4082,8 @@ export interface ExploreSubtotal {
|
|
|
3707
4082
|
/**
|
|
3708
4083
|
* One value per breakdown (ids; masked where private)
|
|
3709
4084
|
*/
|
|
3710
|
-
'keys': Array<
|
|
3711
|
-
'labels': Array<
|
|
4085
|
+
'keys': Array<KeysInner>;
|
|
4086
|
+
'labels': Array<KeysInner>;
|
|
3712
4087
|
/**
|
|
3713
4088
|
* Column id -> number (`null`: '—')
|
|
3714
4089
|
*/
|
|
@@ -3722,7 +4097,7 @@ export interface ExploreSubtotal {
|
|
|
3722
4097
|
[key: string]: any;
|
|
3723
4098
|
} | null;
|
|
3724
4099
|
'change_pct'?: {
|
|
3725
|
-
[key: string]:
|
|
4100
|
+
[key: string]: ChangePctValue;
|
|
3726
4101
|
} | null;
|
|
3727
4102
|
'level': number;
|
|
3728
4103
|
}
|
|
@@ -3734,7 +4109,7 @@ export interface ExploreTotals {
|
|
|
3734
4109
|
[key: string]: any;
|
|
3735
4110
|
} | null;
|
|
3736
4111
|
'change_pct'?: {
|
|
3737
|
-
[key: string]:
|
|
4112
|
+
[key: string]: ChangePctValue;
|
|
3738
4113
|
} | null;
|
|
3739
4114
|
}
|
|
3740
4115
|
export interface ExportClickFiltersSchema {
|
|
@@ -3836,11 +4211,87 @@ export interface ExportScheduleInfoResponse {
|
|
|
3836
4211
|
*/
|
|
3837
4212
|
'livemode': boolean;
|
|
3838
4213
|
}
|
|
4214
|
+
export interface FeatureChangeEventData {
|
|
4215
|
+
/**
|
|
4216
|
+
* Always null for this event type.
|
|
4217
|
+
*/
|
|
4218
|
+
'previous_attributes': any | null;
|
|
4219
|
+
'object': FeatureChangeEventObject;
|
|
4220
|
+
}
|
|
4221
|
+
export interface FeatureChangeEventObject {
|
|
4222
|
+
'object': 'feature_change';
|
|
4223
|
+
/**
|
|
4224
|
+
* The feature's key.
|
|
4225
|
+
*/
|
|
4226
|
+
'key': string;
|
|
4227
|
+
'enabled': boolean;
|
|
4228
|
+
/**
|
|
4229
|
+
* Who changed it: `plan` when a plan change switched it, else the actor's ID.
|
|
4230
|
+
*/
|
|
4231
|
+
'changed_by': string;
|
|
4232
|
+
/**
|
|
4233
|
+
* What happens to the feature's data when it is switched off (`keep`: kept read-only); null when it was switched on.
|
|
4234
|
+
*/
|
|
4235
|
+
'data_action': string | null;
|
|
4236
|
+
/**
|
|
4237
|
+
* true for live-environment data, false for test mode.
|
|
4238
|
+
*/
|
|
4239
|
+
'livemode': boolean;
|
|
4240
|
+
}
|
|
4241
|
+
export interface FeatureDataPurgeEventData {
|
|
4242
|
+
/**
|
|
4243
|
+
* Always null for this event type.
|
|
4244
|
+
*/
|
|
4245
|
+
'previous_attributes': any | null;
|
|
4246
|
+
'object': FeatureDataPurgeEventObject;
|
|
4247
|
+
}
|
|
4248
|
+
export interface FeatureDataPurgeEventObject {
|
|
4249
|
+
'object': 'feature_data_purge';
|
|
4250
|
+
'id': string;
|
|
4251
|
+
/**
|
|
4252
|
+
* The feature whose data was deleted.
|
|
4253
|
+
*/
|
|
4254
|
+
'key': string;
|
|
4255
|
+
/**
|
|
4256
|
+
* Rows deleted, by data category.
|
|
4257
|
+
*/
|
|
4258
|
+
'counts': {
|
|
4259
|
+
[key: string]: number;
|
|
4260
|
+
};
|
|
4261
|
+
/**
|
|
4262
|
+
* true for live-environment data, false for test mode.
|
|
4263
|
+
*/
|
|
4264
|
+
'livemode': boolean;
|
|
4265
|
+
}
|
|
3839
4266
|
export type FeedStatus = 'active' | 'revoked';
|
|
3840
4267
|
export interface FinalizeDelay {
|
|
3841
4268
|
'mode'?: 'auto' | 'fixed';
|
|
3842
4269
|
'hours'?: number | null;
|
|
3843
4270
|
}
|
|
4271
|
+
/**
|
|
4272
|
+
* Installs flagged since the previous batch, for one environment.
|
|
4273
|
+
*/
|
|
4274
|
+
export interface FlaggedInstallBatch {
|
|
4275
|
+
'object': 'fraud_flag_batch';
|
|
4276
|
+
'count': number;
|
|
4277
|
+
'installs': Array<FlaggedInstallItem>;
|
|
4278
|
+
/**
|
|
4279
|
+
* true for live-environment data, false for test mode.
|
|
4280
|
+
*/
|
|
4281
|
+
'livemode': boolean;
|
|
4282
|
+
}
|
|
4283
|
+
export interface FlaggedInstallItem {
|
|
4284
|
+
'install_id': string;
|
|
4285
|
+
'app_id': string;
|
|
4286
|
+
'network': string;
|
|
4287
|
+
'campaign_id': string | null;
|
|
4288
|
+
'score': number;
|
|
4289
|
+
'decision': string;
|
|
4290
|
+
/**
|
|
4291
|
+
* The rules that flagged the install.
|
|
4292
|
+
*/
|
|
4293
|
+
'reasons': Array<KeysInner>;
|
|
4294
|
+
}
|
|
3844
4295
|
export type FraudAction = 'flag' | 'exclude' | 'hold';
|
|
3845
4296
|
export interface FraudCarrierAdjustments {
|
|
3846
4297
|
'networks': Array<FraudCarrierNetwork>;
|
|
@@ -3879,6 +4330,13 @@ export interface FraudCheckResultResponse {
|
|
|
3879
4330
|
}
|
|
3880
4331
|
export type FraudDecision = 'clean' | 'flagged' | 'excluded' | 'held';
|
|
3881
4332
|
export type FraudGroupBy = 'network' | 'campaign' | 'sub_publisher' | 'app' | 'day';
|
|
4333
|
+
export interface FraudInstallFlaggedEventData {
|
|
4334
|
+
/**
|
|
4335
|
+
* Always null for this event type.
|
|
4336
|
+
*/
|
|
4337
|
+
'previous_attributes': any | null;
|
|
4338
|
+
'object': FlaggedInstallBatch;
|
|
4339
|
+
}
|
|
3882
4340
|
export interface FraudInstallInfoResponse {
|
|
3883
4341
|
'object'?: 'fraud_install';
|
|
3884
4342
|
'id': string;
|
|
@@ -3954,6 +4412,7 @@ export interface FraudRuleSettingResponse {
|
|
|
3954
4412
|
export interface FraudRules {
|
|
3955
4413
|
'block_self_referral'?: boolean;
|
|
3956
4414
|
'block_existing_users'?: boolean;
|
|
4415
|
+
'require_account_date'?: boolean;
|
|
3957
4416
|
'block_reinstall_rereferral'?: boolean;
|
|
3958
4417
|
'require_attestation'?: boolean;
|
|
3959
4418
|
'allow_emulators'?: boolean;
|
|
@@ -4118,13 +4577,75 @@ export interface FunnelStepStats {
|
|
|
4118
4577
|
'median_seconds_from_previous': number | null;
|
|
4119
4578
|
}
|
|
4120
4579
|
export type FunnelStepType = 'click' | 'install' | 'goal';
|
|
4121
|
-
|
|
4122
|
-
|
|
4123
|
-
|
|
4124
|
-
|
|
4125
|
-
|
|
4580
|
+
/**
|
|
4581
|
+
* People stuck at a funnel step. Customer IDs are never in the event.
|
|
4582
|
+
*/
|
|
4583
|
+
export interface FunnelStuckBatchObject {
|
|
4584
|
+
'object': 'funnel_stuck_batch';
|
|
4126
4585
|
'id': string;
|
|
4127
|
-
'
|
|
4586
|
+
'funnel': FunnelStuckFunnel;
|
|
4587
|
+
'step': StuckStep;
|
|
4588
|
+
'previous_step': StuckStep;
|
|
4589
|
+
'min_days': number;
|
|
4590
|
+
/**
|
|
4591
|
+
* The day of the run (YYYY-MM-DD).
|
|
4592
|
+
*/
|
|
4593
|
+
'run_on': string;
|
|
4594
|
+
'total_rows': number;
|
|
4595
|
+
'truncated': boolean;
|
|
4596
|
+
'page': number;
|
|
4597
|
+
'pages': number;
|
|
4598
|
+
'page_size': number;
|
|
4599
|
+
'rows': Array<FunnelStuckRow>;
|
|
4600
|
+
/**
|
|
4601
|
+
* Where to fetch page 2 over the API; null with one page.
|
|
4602
|
+
*/
|
|
4603
|
+
'next_page': string | null;
|
|
4604
|
+
/**
|
|
4605
|
+
* true for live-environment data, false for test mode.
|
|
4606
|
+
*/
|
|
4607
|
+
'livemode': boolean;
|
|
4608
|
+
}
|
|
4609
|
+
export interface FunnelStuckEventData {
|
|
4610
|
+
/**
|
|
4611
|
+
* Always null for this event type.
|
|
4612
|
+
*/
|
|
4613
|
+
'previous_attributes': any | null;
|
|
4614
|
+
'object': FunnelStuckBatchObject;
|
|
4615
|
+
}
|
|
4616
|
+
export interface FunnelStuckFunnel {
|
|
4617
|
+
'id': string;
|
|
4618
|
+
'name': string;
|
|
4619
|
+
}
|
|
4620
|
+
export interface FunnelStuckPerson {
|
|
4621
|
+
'id': string;
|
|
4622
|
+
/**
|
|
4623
|
+
* Present only when labels may be sent in webhooks.
|
|
4624
|
+
*/
|
|
4625
|
+
'label'?: string | null;
|
|
4626
|
+
}
|
|
4627
|
+
export interface FunnelStuckRow {
|
|
4628
|
+
'person': FunnelStuckPerson | null;
|
|
4629
|
+
'click_id': string;
|
|
4630
|
+
'last_step': StuckStep;
|
|
4631
|
+
'last_step_at': string;
|
|
4632
|
+
'stuck_days': number;
|
|
4633
|
+
'acquired_via': string | null;
|
|
4634
|
+
'campaign_id': string | null;
|
|
4635
|
+
'link_id': string | null;
|
|
4636
|
+
'partner_id': string | null;
|
|
4637
|
+
'country': string | null;
|
|
4638
|
+
'platform': string | null;
|
|
4639
|
+
'first_time': boolean;
|
|
4640
|
+
'flagged': boolean;
|
|
4641
|
+
}
|
|
4642
|
+
export interface Ga4EventMappingSchema {
|
|
4643
|
+
'clikgate_event': string;
|
|
4644
|
+
'ga4_event': string;
|
|
4645
|
+
}
|
|
4646
|
+
export interface Ga4SendInfoResponse {
|
|
4647
|
+
'id': string;
|
|
4648
|
+
'object'?: 'ga4_send';
|
|
4128
4649
|
'destination_id': string;
|
|
4129
4650
|
'source_event_id': string;
|
|
4130
4651
|
'source_type': string;
|
|
@@ -4268,6 +4789,53 @@ export interface GoalColumn {
|
|
|
4268
4789
|
'group_id'?: string | null;
|
|
4269
4790
|
'group_name'?: string | null;
|
|
4270
4791
|
}
|
|
4792
|
+
export interface GoalCompletedEventData {
|
|
4793
|
+
/**
|
|
4794
|
+
* Always null for this event type.
|
|
4795
|
+
*/
|
|
4796
|
+
'previous_attributes': any | null;
|
|
4797
|
+
'object': GoalCompletedWebhookObject;
|
|
4798
|
+
/**
|
|
4799
|
+
* true when the event arrived before its click was recorded (a click served by the backup redirect during an outage) and was matched once the click appeared. Absent otherwise.
|
|
4800
|
+
*/
|
|
4801
|
+
'recorded_late'?: boolean | null;
|
|
4802
|
+
}
|
|
4803
|
+
export interface GoalCompletedWebhookObject {
|
|
4804
|
+
'object': 'goal_event';
|
|
4805
|
+
'id': string;
|
|
4806
|
+
'goal': string | null;
|
|
4807
|
+
'value': string | null;
|
|
4808
|
+
'value_minor': number | null;
|
|
4809
|
+
'currency': string | null;
|
|
4810
|
+
'first_for_click': boolean | null;
|
|
4811
|
+
'is_first_customer': boolean | null;
|
|
4812
|
+
'link': GoalWebhookRef | null;
|
|
4813
|
+
'campaign': GoalWebhookRef | null;
|
|
4814
|
+
'clicked_at': string | null;
|
|
4815
|
+
'occurred_at': string;
|
|
4816
|
+
'status': string;
|
|
4817
|
+
/**
|
|
4818
|
+
* The alias the event arrived as; null when sent as the goal's key.
|
|
4819
|
+
*/
|
|
4820
|
+
'received_as': string | null;
|
|
4821
|
+
'goal_group': GoalWebhookGroup | null;
|
|
4822
|
+
/**
|
|
4823
|
+
* Your reference for the event. Absent in private mode (only its hash is kept).
|
|
4824
|
+
*/
|
|
4825
|
+
'reference'?: string | null;
|
|
4826
|
+
/**
|
|
4827
|
+
* The event's person; `label` only with "Include labels in webhooks".
|
|
4828
|
+
*/
|
|
4829
|
+
'person': PersonRef | null;
|
|
4830
|
+
/**
|
|
4831
|
+
* true for an event counted from the last 30 days when the goal was set up (sent only when you chose to also send webhooks). Absent otherwise.
|
|
4832
|
+
*/
|
|
4833
|
+
'backfilled'?: boolean | null;
|
|
4834
|
+
/**
|
|
4835
|
+
* true for live-environment data, false for test mode.
|
|
4836
|
+
*/
|
|
4837
|
+
'livemode': boolean;
|
|
4838
|
+
}
|
|
4271
4839
|
export interface GoalDebugResponse {
|
|
4272
4840
|
'object'?: 'goal_debug';
|
|
4273
4841
|
'private_mode': boolean;
|
|
@@ -4411,6 +4979,37 @@ export interface GoalEventSchema {
|
|
|
4411
4979
|
*/
|
|
4412
4980
|
'platform'?: 'ios' | 'android' | 'macos' | 'windows' | 'linux' | 'other' | null;
|
|
4413
4981
|
}
|
|
4982
|
+
/**
|
|
4983
|
+
* A goal event as goal webhooks show it. `value` is in normal units, as a decimal string.
|
|
4984
|
+
*/
|
|
4985
|
+
export interface GoalEventWebhookObject {
|
|
4986
|
+
'object': 'goal_event';
|
|
4987
|
+
'id': string;
|
|
4988
|
+
'goal': string | null;
|
|
4989
|
+
'value': string | null;
|
|
4990
|
+
'value_minor': number | null;
|
|
4991
|
+
'currency': string | null;
|
|
4992
|
+
'first_for_click': boolean | null;
|
|
4993
|
+
'is_first_customer': boolean | null;
|
|
4994
|
+
'link': GoalWebhookRef | null;
|
|
4995
|
+
'campaign': GoalWebhookRef | null;
|
|
4996
|
+
'clicked_at': string | null;
|
|
4997
|
+
'occurred_at': string;
|
|
4998
|
+
'status': string;
|
|
4999
|
+
/**
|
|
5000
|
+
* The alias the event arrived as; null when sent as the goal's key.
|
|
5001
|
+
*/
|
|
5002
|
+
'received_as': string | null;
|
|
5003
|
+
'goal_group': GoalWebhookGroup | null;
|
|
5004
|
+
/**
|
|
5005
|
+
* Your reference for the event. Absent in private mode (only its hash is kept).
|
|
5006
|
+
*/
|
|
5007
|
+
'reference'?: string | null;
|
|
5008
|
+
/**
|
|
5009
|
+
* true for live-environment data, false for test mode.
|
|
5010
|
+
*/
|
|
5011
|
+
'livemode': boolean;
|
|
5012
|
+
}
|
|
4414
5013
|
export interface GoalEventsBatchSchema {
|
|
4415
5014
|
'events': Array<{
|
|
4416
5015
|
[key: string]: any;
|
|
@@ -4654,6 +5253,27 @@ export interface GoalRejectionInfoResponse {
|
|
|
4654
5253
|
*/
|
|
4655
5254
|
'livemode': boolean;
|
|
4656
5255
|
}
|
|
5256
|
+
export interface GoalReversalWebhookInfo {
|
|
5257
|
+
'id': string;
|
|
5258
|
+
/**
|
|
5259
|
+
* The amount reversed, in normal units; null when no amount was given.
|
|
5260
|
+
*/
|
|
5261
|
+
'value': string | null;
|
|
5262
|
+
'value_minor': number | null;
|
|
5263
|
+
'reason': string | null;
|
|
5264
|
+
/**
|
|
5265
|
+
* What is left of the event's value, in normal units.
|
|
5266
|
+
*/
|
|
5267
|
+
'remaining_value': string | null;
|
|
5268
|
+
}
|
|
5269
|
+
export interface GoalReversedEventData {
|
|
5270
|
+
/**
|
|
5271
|
+
* Always null for this event type.
|
|
5272
|
+
*/
|
|
5273
|
+
'previous_attributes': any | null;
|
|
5274
|
+
'object': GoalEventWebhookObject;
|
|
5275
|
+
'reversal': GoalReversalWebhookInfo;
|
|
5276
|
+
}
|
|
4657
5277
|
/**
|
|
4658
5278
|
* Goals settings (`GET` / `PATCH /v1/goals/settings`): read with goals_payments:view, changed with manage.
|
|
4659
5279
|
*/
|
|
@@ -4712,6 +5332,13 @@ export interface GoalSuggestionInfo {
|
|
|
4712
5332
|
*/
|
|
4713
5333
|
'livemode': boolean;
|
|
4714
5334
|
}
|
|
5335
|
+
export interface GoalWebhookGroup {
|
|
5336
|
+
'id': string;
|
|
5337
|
+
'name': string;
|
|
5338
|
+
}
|
|
5339
|
+
export interface GoalWebhookRef {
|
|
5340
|
+
'id': string;
|
|
5341
|
+
}
|
|
4715
5342
|
/**
|
|
4716
5343
|
* What the business adds to its Google Ads account for Data Manager uploads (`mode = service_account`).
|
|
4717
5344
|
*/
|
|
@@ -4807,6 +5434,8 @@ export interface IdentifyPersonResponse {
|
|
|
4807
5434
|
'object'?: 'person_identified';
|
|
4808
5435
|
'person_id': string;
|
|
4809
5436
|
'label_ignored'?: 'plan' | 'lower_rank' | null;
|
|
5437
|
+
'customer_since_ignored'?: 'unverified' | 'invalid' | null;
|
|
5438
|
+
'customer_id_warning'?: 'looks_like_phone' | 'looks_like_email' | 'looks_like_national_id' | null;
|
|
4810
5439
|
/**
|
|
4811
5440
|
* true for live-environment data, false for test mode.
|
|
4812
5441
|
*/
|
|
@@ -4826,6 +5455,36 @@ export interface IdentityDedupeRules {
|
|
|
4826
5455
|
'require_verified'?: boolean;
|
|
4827
5456
|
'action'?: 'reject' | 'flag';
|
|
4828
5457
|
}
|
|
5458
|
+
export interface IdentityDuplicateDetectedEventData {
|
|
5459
|
+
/**
|
|
5460
|
+
* Always null for this event type.
|
|
5461
|
+
*/
|
|
5462
|
+
'previous_attributes': any | null;
|
|
5463
|
+
'object': IdentityDuplicateObject;
|
|
5464
|
+
}
|
|
5465
|
+
/**
|
|
5466
|
+
* The identity match. Never carries a hash.
|
|
5467
|
+
*/
|
|
5468
|
+
export interface IdentityDuplicateObject {
|
|
5469
|
+
'id': string;
|
|
5470
|
+
'object'?: 'identity_match';
|
|
5471
|
+
'app_scope': string;
|
|
5472
|
+
'signal_type': string;
|
|
5473
|
+
'subject_a': SubjectInfo;
|
|
5474
|
+
'subject_b': SubjectInfo;
|
|
5475
|
+
'context': string;
|
|
5476
|
+
'status': string;
|
|
5477
|
+
'first_detected_at': string;
|
|
5478
|
+
'updated_at': string;
|
|
5479
|
+
/**
|
|
5480
|
+
* The same as `id`.
|
|
5481
|
+
*/
|
|
5482
|
+
'match_id': string;
|
|
5483
|
+
/**
|
|
5484
|
+
* true for live-environment data, false for test mode.
|
|
5485
|
+
*/
|
|
5486
|
+
'livemode': boolean;
|
|
5487
|
+
}
|
|
4829
5488
|
export interface IdentityMatchInfoResponse {
|
|
4830
5489
|
'id': string;
|
|
4831
5490
|
'object'?: 'identity_match';
|
|
@@ -5030,6 +5689,19 @@ export interface IngestReceiptResponse {
|
|
|
5030
5689
|
*/
|
|
5031
5690
|
'livemode': boolean;
|
|
5032
5691
|
}
|
|
5692
|
+
export interface InstallAttributionUpdatedEventData {
|
|
5693
|
+
/**
|
|
5694
|
+
* Always null for this event type.
|
|
5695
|
+
*/
|
|
5696
|
+
'previous_attributes': any | null;
|
|
5697
|
+
'object': InstallInfoResponse;
|
|
5698
|
+
/**
|
|
5699
|
+
* Apple Ads attribution as Apple's AdServices API returned it, when the update came from Apple Ads. Absent otherwise.
|
|
5700
|
+
*/
|
|
5701
|
+
'apple_search_ads'?: {
|
|
5702
|
+
[key: string]: any;
|
|
5703
|
+
} | null;
|
|
5704
|
+
}
|
|
5033
5705
|
/**
|
|
5034
5706
|
* The "See details" drawer: one slice of Organic vs non-organic, broken down.
|
|
5035
5707
|
*/
|
|
@@ -5056,6 +5728,13 @@ export interface InstallDetailsRow {
|
|
|
5056
5728
|
'active_users': number;
|
|
5057
5729
|
'share': number | null;
|
|
5058
5730
|
}
|
|
5731
|
+
export interface InstallEventData {
|
|
5732
|
+
/**
|
|
5733
|
+
* Always null for this event type.
|
|
5734
|
+
*/
|
|
5735
|
+
'previous_attributes': any | null;
|
|
5736
|
+
'object': InstallInfoResponse;
|
|
5737
|
+
}
|
|
5059
5738
|
/**
|
|
5060
5739
|
* The install object in API responses and install.* webhooks. Never holds push tokens.
|
|
5061
5740
|
*/
|
|
@@ -5082,6 +5761,8 @@ export interface InstallInfoResponse {
|
|
|
5082
5761
|
'is_reinstall': boolean;
|
|
5083
5762
|
'previous_install_id': string | null;
|
|
5084
5763
|
'attribution_status': string;
|
|
5764
|
+
'install_kind'?: string;
|
|
5765
|
+
'new_phone_of_existing_customer'?: boolean;
|
|
5085
5766
|
'match_type': string | null;
|
|
5086
5767
|
'confidence': number | null;
|
|
5087
5768
|
'click_id': string | null;
|
|
@@ -5148,7 +5829,46 @@ export interface InviteLinkResponse {
|
|
|
5148
5829
|
*/
|
|
5149
5830
|
'livemode': boolean;
|
|
5150
5831
|
}
|
|
5832
|
+
export interface InvoiceEventData {
|
|
5833
|
+
/**
|
|
5834
|
+
* Always null for this event type.
|
|
5835
|
+
*/
|
|
5836
|
+
'previous_attributes': any | null;
|
|
5837
|
+
'object': InvoiceEventObject;
|
|
5838
|
+
}
|
|
5839
|
+
export interface InvoiceEventObject {
|
|
5840
|
+
'object': 'invoice';
|
|
5841
|
+
'id': string;
|
|
5842
|
+
'number': string | null;
|
|
5843
|
+
'kind': string;
|
|
5844
|
+
'status': string;
|
|
5845
|
+
'currency': string;
|
|
5846
|
+
'subtotal_minor': number;
|
|
5847
|
+
'vat_minor': number;
|
|
5848
|
+
'total_minor': number;
|
|
5849
|
+
'amount_paid_minor': number;
|
|
5850
|
+
'wht_minor': number;
|
|
5851
|
+
'credited_minor': number;
|
|
5852
|
+
'balance_due_minor': number;
|
|
5853
|
+
'issued_at': string | null;
|
|
5854
|
+
'due_at': string | null;
|
|
5855
|
+
'paid_at': string | null;
|
|
5856
|
+
'voided_at': string | null;
|
|
5857
|
+
'upgrade_request_id': string | null;
|
|
5858
|
+
'subscription_id': string | null;
|
|
5859
|
+
/**
|
|
5860
|
+
* true for live-environment data, false for test mode.
|
|
5861
|
+
*/
|
|
5862
|
+
'livemode': boolean;
|
|
5863
|
+
}
|
|
5151
5864
|
export type IosInterstitial = 'auto' | 'always' | 'never';
|
|
5865
|
+
export interface JobEventData {
|
|
5866
|
+
/**
|
|
5867
|
+
* Always null for this event type.
|
|
5868
|
+
*/
|
|
5869
|
+
'previous_attributes': any | null;
|
|
5870
|
+
'object': JobInfoResponse;
|
|
5871
|
+
}
|
|
5152
5872
|
export interface JobInfoResponse {
|
|
5153
5873
|
'id': string;
|
|
5154
5874
|
'object'?: 'job';
|
|
@@ -5157,13 +5877,118 @@ export interface JobInfoResponse {
|
|
|
5157
5877
|
'total': number;
|
|
5158
5878
|
'succeeded': number;
|
|
5159
5879
|
'failed': number;
|
|
5160
|
-
'results': Array<
|
|
5161
|
-
[key: string]: any;
|
|
5162
|
-
}>;
|
|
5880
|
+
'results': Array<JobResultItem>;
|
|
5163
5881
|
'created_at': string;
|
|
5164
5882
|
'finished_at': string | null;
|
|
5165
5883
|
'livemode'?: boolean;
|
|
5166
5884
|
}
|
|
5885
|
+
/**
|
|
5886
|
+
* Why an item (or the whole job) failed.
|
|
5887
|
+
*/
|
|
5888
|
+
export interface JobResultError {
|
|
5889
|
+
/**
|
|
5890
|
+
* `invalid_request` or `server`.
|
|
5891
|
+
*/
|
|
5892
|
+
'type': string;
|
|
5893
|
+
'code': string;
|
|
5894
|
+
/**
|
|
5895
|
+
* What went wrong, in words. Absent when it doesn't apply.
|
|
5896
|
+
*/
|
|
5897
|
+
'message'?: string;
|
|
5898
|
+
/**
|
|
5899
|
+
* The field of the item that was refused. Absent when it doesn't apply.
|
|
5900
|
+
*/
|
|
5901
|
+
'param'?: string | null;
|
|
5902
|
+
/**
|
|
5903
|
+
* QR placement downloads: the placement left out. Absent when it doesn't apply.
|
|
5904
|
+
*/
|
|
5905
|
+
'number'?: number;
|
|
5906
|
+
/**
|
|
5907
|
+
* QR placement downloads: why it was left out. Absent when it doesn't apply.
|
|
5908
|
+
*/
|
|
5909
|
+
'reasons'?: Array<string>;
|
|
5910
|
+
}
|
|
5911
|
+
/**
|
|
5912
|
+
* One result of a job. Bulk link jobs and referrer imports send one item per input item (`index`, `ok`, then
|
|
5913
|
+
* `link_id` or `referrer_id` and `created`, or `error`). Exports and downloads send the file (`url`, `expires_at`,
|
|
5914
|
+
* `rows` or `files`, `run_id` for reports) or an `error`. A test data reset sends one item per table (`table`,
|
|
5915
|
+
* `deleted`). Only the keys that apply are present.
|
|
5916
|
+
*/
|
|
5917
|
+
export interface JobResultItem {
|
|
5918
|
+
/**
|
|
5919
|
+
* The input item's position (0 is the first). Absent when it doesn't apply.
|
|
5920
|
+
*/
|
|
5921
|
+
'index'?: number;
|
|
5922
|
+
/**
|
|
5923
|
+
* Whether the input item succeeded. Absent when it doesn't apply.
|
|
5924
|
+
*/
|
|
5925
|
+
'ok'?: boolean;
|
|
5926
|
+
/**
|
|
5927
|
+
* Bulk link jobs: the link created or changed. Absent when it doesn't apply.
|
|
5928
|
+
*/
|
|
5929
|
+
'link_id'?: string;
|
|
5930
|
+
/**
|
|
5931
|
+
* Referrer imports: the referrer. Absent when it doesn't apply.
|
|
5932
|
+
*/
|
|
5933
|
+
'referrer_id'?: string;
|
|
5934
|
+
/**
|
|
5935
|
+
* Referrer imports: true when the referrer is new, false when updated. Absent when it doesn't apply.
|
|
5936
|
+
*/
|
|
5937
|
+
'created'?: boolean;
|
|
5938
|
+
/**
|
|
5939
|
+
* Exports and downloads: a signed link to the file. Absent when it doesn't apply.
|
|
5940
|
+
*/
|
|
5941
|
+
'url'?: string;
|
|
5942
|
+
/**
|
|
5943
|
+
* When `url` stops working (Unix seconds). Absent when it doesn't apply.
|
|
5944
|
+
*/
|
|
5945
|
+
'expires_at'?: number;
|
|
5946
|
+
/**
|
|
5947
|
+
* Exports: the rows in the file. Absent when it doesn't apply.
|
|
5948
|
+
*/
|
|
5949
|
+
'rows'?: number;
|
|
5950
|
+
/**
|
|
5951
|
+
* QR placement downloads: the images in the ZIP. Absent when it doesn't apply.
|
|
5952
|
+
*/
|
|
5953
|
+
'files'?: number;
|
|
5954
|
+
/**
|
|
5955
|
+
* Report exports: the report run exported. Absent when it doesn't apply.
|
|
5956
|
+
*/
|
|
5957
|
+
'run_id'?: string;
|
|
5958
|
+
/**
|
|
5959
|
+
* Test data resets: the kind of data deleted. Absent when it doesn't apply.
|
|
5960
|
+
*/
|
|
5961
|
+
'table'?: string;
|
|
5962
|
+
/**
|
|
5963
|
+
* Test data resets: how many rows were deleted. Absent when it doesn't apply.
|
|
5964
|
+
*/
|
|
5965
|
+
'deleted'?: number;
|
|
5966
|
+
'error'?: JobResultError;
|
|
5967
|
+
}
|
|
5968
|
+
export type KeysInner = string;
|
|
5969
|
+
export interface KnownCustomerRemoveResponse {
|
|
5970
|
+
'removed': boolean;
|
|
5971
|
+
}
|
|
5972
|
+
export interface KnownCustomerRemoveSchema {
|
|
5973
|
+
'customer_id': string;
|
|
5974
|
+
}
|
|
5975
|
+
export interface KnownCustomersImportResponse {
|
|
5976
|
+
'object'?: 'known_customers_import';
|
|
5977
|
+
'accepted': number;
|
|
5978
|
+
'refused': number;
|
|
5979
|
+
'refused_by_reason': {
|
|
5980
|
+
[key: string]: number;
|
|
5981
|
+
};
|
|
5982
|
+
/**
|
|
5983
|
+
* true for live-environment data, false for test mode.
|
|
5984
|
+
*/
|
|
5985
|
+
'livemode': boolean;
|
|
5986
|
+
}
|
|
5987
|
+
export interface KnownCustomersImportSchema {
|
|
5988
|
+
'customers': Array<{
|
|
5989
|
+
[key: string]: any;
|
|
5990
|
+
}>;
|
|
5991
|
+
}
|
|
5167
5992
|
export interface LabelHistoryEntry {
|
|
5168
5993
|
'label': string | null;
|
|
5169
5994
|
'source': string;
|
|
@@ -5267,6 +6092,40 @@ export interface LeaderboardInfoResponse {
|
|
|
5267
6092
|
'livemode': boolean;
|
|
5268
6093
|
}
|
|
5269
6094
|
export type LeaderboardMetric = 'qualified' | 'installs' | 'signups' | 'step' | 'points' | 'goal';
|
|
6095
|
+
/**
|
|
6096
|
+
* What the period is scored on. `goal_key`, `measure` and `currency` are present only on goal metrics.
|
|
6097
|
+
*/
|
|
6098
|
+
export interface LeaderboardMetricInfo {
|
|
6099
|
+
'type': string;
|
|
6100
|
+
'step_goal': string | null;
|
|
6101
|
+
'weights': {
|
|
6102
|
+
[key: string]: number;
|
|
6103
|
+
} | null;
|
|
6104
|
+
'applies_to_metric': boolean;
|
|
6105
|
+
'goal_key'?: string | null;
|
|
6106
|
+
'measure'?: string | null;
|
|
6107
|
+
'currency'?: string | null;
|
|
6108
|
+
}
|
|
6109
|
+
/**
|
|
6110
|
+
* One ranked referrer (eligible referrers only; opted-out ones are flagged).
|
|
6111
|
+
*/
|
|
6112
|
+
export interface LeaderboardPeriodEntry {
|
|
6113
|
+
'rank': number;
|
|
6114
|
+
'referrer_id': string;
|
|
6115
|
+
'display': string;
|
|
6116
|
+
'score': number;
|
|
6117
|
+
'pending': number;
|
|
6118
|
+
'adjustments': number;
|
|
6119
|
+
'tie_break_at': string | null;
|
|
6120
|
+
'opted_out': boolean;
|
|
6121
|
+
}
|
|
6122
|
+
export interface LeaderboardPeriodEventData {
|
|
6123
|
+
/**
|
|
6124
|
+
* Always null for this event type.
|
|
6125
|
+
*/
|
|
6126
|
+
'previous_attributes': any | null;
|
|
6127
|
+
'object': LeaderboardPeriodObject;
|
|
6128
|
+
}
|
|
5270
6129
|
export interface LeaderboardPeriodInfoResponse {
|
|
5271
6130
|
'id': string;
|
|
5272
6131
|
'object'?: 'leaderboard_period';
|
|
@@ -5289,6 +6148,97 @@ export interface LeaderboardPeriodInfoResponse {
|
|
|
5289
6148
|
*/
|
|
5290
6149
|
'livemode': boolean;
|
|
5291
6150
|
}
|
|
6151
|
+
/**
|
|
6152
|
+
* A leaderboard period with its top entries.
|
|
6153
|
+
*/
|
|
6154
|
+
export interface LeaderboardPeriodObject {
|
|
6155
|
+
'id': string;
|
|
6156
|
+
'object': 'leaderboard_period';
|
|
6157
|
+
'leaderboard_id': string;
|
|
6158
|
+
'leaderboard': LeaderboardRef;
|
|
6159
|
+
'key': string;
|
|
6160
|
+
'status': string;
|
|
6161
|
+
'starts_at': string | null;
|
|
6162
|
+
'ends_at': string | null;
|
|
6163
|
+
'finalize_at': string | null;
|
|
6164
|
+
'finalized_at': string | null;
|
|
6165
|
+
'finalized_by': string | null;
|
|
6166
|
+
'metric': LeaderboardMetricInfo;
|
|
6167
|
+
'post_final_changes': Array<LeaderboardPostFinalChange>;
|
|
6168
|
+
'challenge_id': string | null;
|
|
6169
|
+
/**
|
|
6170
|
+
* The top of the ranking.
|
|
6171
|
+
*/
|
|
6172
|
+
'entries': Array<LeaderboardPeriodEntry>;
|
|
6173
|
+
/**
|
|
6174
|
+
* The trophy winners; absent when the period has no trophy.
|
|
6175
|
+
*/
|
|
6176
|
+
'winners'?: Array<LeaderboardWinnerObject> | null;
|
|
6177
|
+
/**
|
|
6178
|
+
* true for live-environment data, false for test mode.
|
|
6179
|
+
*/
|
|
6180
|
+
'livemode': boolean;
|
|
6181
|
+
}
|
|
6182
|
+
/**
|
|
6183
|
+
* The period a ranking or trophy belongs to.
|
|
6184
|
+
*/
|
|
6185
|
+
export interface LeaderboardPeriodRef {
|
|
6186
|
+
'key': string;
|
|
6187
|
+
'status': string;
|
|
6188
|
+
'starts_at': string | null;
|
|
6189
|
+
'ends_at': string | null;
|
|
6190
|
+
}
|
|
6191
|
+
/**
|
|
6192
|
+
* A reversal after the period became final, listed but never applied. Referral changes carry `state_change_id`,
|
|
6193
|
+
* `referral_id`, `referrer_id` and `from_status`; goal reversals carry `conversion_id`, `goal`, `referrer_ids` and
|
|
6194
|
+
* `currency`.
|
|
6195
|
+
*/
|
|
6196
|
+
export interface LeaderboardPostFinalChange {
|
|
6197
|
+
'state_change_id'?: string | null;
|
|
6198
|
+
'referral_id'?: string | null;
|
|
6199
|
+
'referrer_id'?: string | null;
|
|
6200
|
+
'conversion_id'?: string | null;
|
|
6201
|
+
'goal'?: string | null;
|
|
6202
|
+
'referrer_ids'?: Array<string> | null;
|
|
6203
|
+
'from_status'?: string | null;
|
|
6204
|
+
'to_status': string;
|
|
6205
|
+
'points': number;
|
|
6206
|
+
'currency'?: string | null;
|
|
6207
|
+
'at': string | null;
|
|
6208
|
+
}
|
|
6209
|
+
/**
|
|
6210
|
+
* A referrer entered or left the top of a leaderboard, or moved within it.
|
|
6211
|
+
*/
|
|
6212
|
+
export interface LeaderboardRankChangeObject {
|
|
6213
|
+
'object': 'leaderboard_rank_change';
|
|
6214
|
+
'leaderboard_id': string;
|
|
6215
|
+
'period': LeaderboardPeriodRef;
|
|
6216
|
+
'referrer_id': string;
|
|
6217
|
+
'previous_rank': number | null;
|
|
6218
|
+
'rank': number | null;
|
|
6219
|
+
/**
|
|
6220
|
+
* `entered`, `left`, `moved_up` or `moved_down`.
|
|
6221
|
+
*/
|
|
6222
|
+
'change': string;
|
|
6223
|
+
'top_n': number;
|
|
6224
|
+
'score': number;
|
|
6225
|
+
/**
|
|
6226
|
+
* true for live-environment data, false for test mode.
|
|
6227
|
+
*/
|
|
6228
|
+
'livemode': boolean;
|
|
6229
|
+
}
|
|
6230
|
+
export interface LeaderboardRankChangedEventData {
|
|
6231
|
+
/**
|
|
6232
|
+
* Always null for this event type.
|
|
6233
|
+
*/
|
|
6234
|
+
'previous_attributes': any | null;
|
|
6235
|
+
'object': LeaderboardRankChangeObject;
|
|
6236
|
+
}
|
|
6237
|
+
export interface LeaderboardRef {
|
|
6238
|
+
'id': string;
|
|
6239
|
+
'name': string;
|
|
6240
|
+
'program_id': string;
|
|
6241
|
+
}
|
|
5292
6242
|
export interface LeaderboardReferrerResponse {
|
|
5293
6243
|
'object'?: 'leaderboard_referrer';
|
|
5294
6244
|
'leaderboard_id': string;
|
|
@@ -5341,6 +6291,25 @@ export interface LeaderboardResponse {
|
|
|
5341
6291
|
*/
|
|
5342
6292
|
'livemode': boolean;
|
|
5343
6293
|
}
|
|
6294
|
+
export interface LeaderboardTargetEventData {
|
|
6295
|
+
/**
|
|
6296
|
+
* Always null for this event type.
|
|
6297
|
+
*/
|
|
6298
|
+
'previous_attributes': any | null;
|
|
6299
|
+
'object': LeaderboardWinnerObject;
|
|
6300
|
+
}
|
|
6301
|
+
/**
|
|
6302
|
+
* The trophy target. Value boards also give the minor-unit threshold (`score_minor`) and `currency`.
|
|
6303
|
+
*/
|
|
6304
|
+
export interface LeaderboardTargetInfo {
|
|
6305
|
+
'score': Score;
|
|
6306
|
+
'label': string;
|
|
6307
|
+
'prize_text': string | null;
|
|
6308
|
+
'mode': string;
|
|
6309
|
+
'n': number | null;
|
|
6310
|
+
'score_minor'?: number | null;
|
|
6311
|
+
'currency'?: string | null;
|
|
6312
|
+
}
|
|
5344
6313
|
/**
|
|
5345
6314
|
* GET /v1/leaderboards/{id}/trophy. Never any pace or "days to go".
|
|
5346
6315
|
*/
|
|
@@ -5365,6 +6334,29 @@ export interface LeaderboardTrophyResponse {
|
|
|
5365
6334
|
*/
|
|
5366
6335
|
'livemode': boolean;
|
|
5367
6336
|
}
|
|
6337
|
+
/**
|
|
6338
|
+
* A referrer who reached a leaderboard's or challenge's trophy target.
|
|
6339
|
+
*/
|
|
6340
|
+
export interface LeaderboardWinnerObject {
|
|
6341
|
+
'id': string;
|
|
6342
|
+
'object': 'leaderboard_target_winner';
|
|
6343
|
+
'leaderboard_id': string;
|
|
6344
|
+
'challenge_id': string | null;
|
|
6345
|
+
'period': LeaderboardPeriodRef;
|
|
6346
|
+
'segment': string;
|
|
6347
|
+
'referrer_id': string;
|
|
6348
|
+
'display': string | null;
|
|
6349
|
+
'status': string;
|
|
6350
|
+
'position': number | null;
|
|
6351
|
+
'reached_at': string | null;
|
|
6352
|
+
'score_at_reach': number;
|
|
6353
|
+
'revoked_at': string | null;
|
|
6354
|
+
'target': LeaderboardTargetInfo;
|
|
6355
|
+
/**
|
|
6356
|
+
* true for live-environment data, false for test mode.
|
|
6357
|
+
*/
|
|
6358
|
+
'livemode': boolean;
|
|
6359
|
+
}
|
|
5368
6360
|
/**
|
|
5369
6361
|
* A destination change waiting for a second person (returned with 202).
|
|
5370
6362
|
*/
|
|
@@ -5388,6 +6380,13 @@ export interface LinkChangeRequestInfoResponse {
|
|
|
5388
6380
|
*/
|
|
5389
6381
|
'livemode': boolean;
|
|
5390
6382
|
}
|
|
6383
|
+
export interface LinkCreatedEventData {
|
|
6384
|
+
/**
|
|
6385
|
+
* Always null for this event type.
|
|
6386
|
+
*/
|
|
6387
|
+
'previous_attributes': any | null;
|
|
6388
|
+
'object': LinkInfoResponse;
|
|
6389
|
+
}
|
|
5391
6390
|
export interface LinkDefaults {
|
|
5392
6391
|
'deep_link_path'?: string | null;
|
|
5393
6392
|
'deep_link_data'?: {
|
|
@@ -5398,6 +6397,46 @@ export interface LinkDefaults {
|
|
|
5398
6397
|
'og_image_url'?: string | null;
|
|
5399
6398
|
'fallback_url'?: string | null;
|
|
5400
6399
|
}
|
|
6400
|
+
/**
|
|
6401
|
+
* Who changed the destination.
|
|
6402
|
+
*/
|
|
6403
|
+
export interface LinkDestinationActor {
|
|
6404
|
+
/**
|
|
6405
|
+
* The kind of actor: user, key, staff, system...
|
|
6406
|
+
*/
|
|
6407
|
+
'type': string;
|
|
6408
|
+
'id': string;
|
|
6409
|
+
/**
|
|
6410
|
+
* The API key's prefix when an API key made the change.
|
|
6411
|
+
*/
|
|
6412
|
+
'api_key_prefix': string | null;
|
|
6413
|
+
/**
|
|
6414
|
+
* Who asked for the change, when it was approved as a change request.
|
|
6415
|
+
*/
|
|
6416
|
+
'requested_by'?: string | null;
|
|
6417
|
+
/**
|
|
6418
|
+
* The approved change request, when the change needed a second person.
|
|
6419
|
+
*/
|
|
6420
|
+
'change_request_id'?: string | null;
|
|
6421
|
+
}
|
|
6422
|
+
export interface LinkDestinationChangedEventData {
|
|
6423
|
+
/**
|
|
6424
|
+
* Always null for this event type.
|
|
6425
|
+
*/
|
|
6426
|
+
'previous_attributes': any | null;
|
|
6427
|
+
'object': LinkInfoResponse;
|
|
6428
|
+
/**
|
|
6429
|
+
* The destination before the change.
|
|
6430
|
+
*/
|
|
6431
|
+
'from': string;
|
|
6432
|
+
/**
|
|
6433
|
+
* The new destination.
|
|
6434
|
+
*/
|
|
6435
|
+
'to': string;
|
|
6436
|
+
'actor': LinkDestinationActor;
|
|
6437
|
+
'actor_type': string;
|
|
6438
|
+
'api_key_prefix': string | null;
|
|
6439
|
+
}
|
|
5401
6440
|
/**
|
|
5402
6441
|
* Password page views, wrong attempts and successful opens; blocked taps by country (counters, not clicks).
|
|
5403
6442
|
*/
|
|
@@ -5525,14 +6564,33 @@ export interface LinkReviewRequestResponse {
|
|
|
5525
6564
|
*/
|
|
5526
6565
|
'livemode': boolean;
|
|
5527
6566
|
}
|
|
6567
|
+
/**
|
|
6568
|
+
* What a visitor must match for the rule to apply; only the conditions the rule uses are present.
|
|
6569
|
+
*/
|
|
6570
|
+
export interface LinkRuleConditions {
|
|
6571
|
+
/**
|
|
6572
|
+
* Operating systems (lowercase). Absent when not a condition.
|
|
6573
|
+
*/
|
|
6574
|
+
'os'?: Array<string>;
|
|
6575
|
+
/**
|
|
6576
|
+
* Device types (lowercase). Absent when not a condition.
|
|
6577
|
+
*/
|
|
6578
|
+
'device_type'?: Array<string>;
|
|
6579
|
+
/**
|
|
6580
|
+
* ISO 3166-1 alpha-2 country codes. Absent when not a condition.
|
|
6581
|
+
*/
|
|
6582
|
+
'country'?: Array<string>;
|
|
6583
|
+
/**
|
|
6584
|
+
* Language tags such as `en` or `fr-ca`. Absent when not a condition.
|
|
6585
|
+
*/
|
|
6586
|
+
'language'?: Array<string>;
|
|
6587
|
+
}
|
|
5528
6588
|
export interface LinkRuleInfoResponse {
|
|
5529
6589
|
'id': string;
|
|
5530
6590
|
'object'?: 'link_rule';
|
|
5531
6591
|
'link_id': string;
|
|
5532
6592
|
'priority': number;
|
|
5533
|
-
'conditions':
|
|
5534
|
-
[key: string]: any;
|
|
5535
|
-
};
|
|
6593
|
+
'conditions': LinkRuleConditions;
|
|
5536
6594
|
'destination_url': string | null;
|
|
5537
6595
|
'app_id': string | null;
|
|
5538
6596
|
'created_at': string;
|
|
@@ -5609,10 +6667,48 @@ export interface LinkSafetySettingsSchema {
|
|
|
5609
6667
|
[key: string]: boolean;
|
|
5610
6668
|
} | null;
|
|
5611
6669
|
}
|
|
5612
|
-
export interface LinkSafetyWarning {
|
|
5613
|
-
'code': string;
|
|
5614
|
-
'param': string;
|
|
5615
|
-
'message': string;
|
|
6670
|
+
export interface LinkSafetyWarning {
|
|
6671
|
+
'code': string;
|
|
6672
|
+
'param': string;
|
|
6673
|
+
'message': string;
|
|
6674
|
+
}
|
|
6675
|
+
export interface LinkStatsHourlyEventData {
|
|
6676
|
+
/**
|
|
6677
|
+
* Always null for this event type.
|
|
6678
|
+
*/
|
|
6679
|
+
'previous_attributes': any | null;
|
|
6680
|
+
'object': LinkStatsHourlyObject;
|
|
6681
|
+
}
|
|
6682
|
+
export interface LinkStatsHourlyLink {
|
|
6683
|
+
'id': string;
|
|
6684
|
+
'external_reference': string | null;
|
|
6685
|
+
/**
|
|
6686
|
+
* Human clicks in the hour (bots excluded).
|
|
6687
|
+
*/
|
|
6688
|
+
'clicks': number;
|
|
6689
|
+
'unique_visitors': number;
|
|
6690
|
+
'bot_clicks': number;
|
|
6691
|
+
'conversions': number;
|
|
6692
|
+
}
|
|
6693
|
+
/**
|
|
6694
|
+
* One hour of link statistics: links with clicks or conversions in the hour, at most 500 per event.
|
|
6695
|
+
*/
|
|
6696
|
+
export interface LinkStatsHourlyObject {
|
|
6697
|
+
/**
|
|
6698
|
+
* The start of the hour (UTC, ISO 8601).
|
|
6699
|
+
*/
|
|
6700
|
+
'hour': string;
|
|
6701
|
+
'links': Array<LinkStatsHourlyLink>;
|
|
6702
|
+
}
|
|
6703
|
+
export interface LinkStatusEventData {
|
|
6704
|
+
'previous_attributes': LinkStatusPrevious;
|
|
6705
|
+
'object': LinkInfoResponse;
|
|
6706
|
+
}
|
|
6707
|
+
/**
|
|
6708
|
+
* The link's status before the change.
|
|
6709
|
+
*/
|
|
6710
|
+
export interface LinkStatusPrevious {
|
|
6711
|
+
'status': string;
|
|
5616
6712
|
}
|
|
5617
6713
|
/**
|
|
5618
6714
|
* `GET /v1/link-subdomains/availability?name=`.
|
|
@@ -5637,8 +6733,17 @@ export interface LinkSubdomainAvailabilityResponse {
|
|
|
5637
6733
|
* link's unknown clicks over the last 7 days likely came from WhatsApp shares.
|
|
5638
6734
|
*/
|
|
5639
6735
|
export type LinkSuggestion = 'make_whatsapp_link';
|
|
6736
|
+
export interface LinkUpdatedEventData {
|
|
6737
|
+
/**
|
|
6738
|
+
* The fields that changed, with their earlier values.
|
|
6739
|
+
*/
|
|
6740
|
+
'previous_attributes': {
|
|
6741
|
+
[key: string]: any;
|
|
6742
|
+
} | null;
|
|
6743
|
+
'object': LinkInfoResponse;
|
|
6744
|
+
}
|
|
5640
6745
|
/**
|
|
5641
|
-
* The link on one active domain of its group
|
|
6746
|
+
* The link on one active domain of its group.
|
|
5642
6747
|
*/
|
|
5643
6748
|
export interface LinkUrlResponse {
|
|
5644
6749
|
'domain': string;
|
|
@@ -6196,6 +7301,15 @@ export interface MatchQualityResponse {
|
|
|
6196
7301
|
*/
|
|
6197
7302
|
'livemode': boolean;
|
|
6198
7303
|
}
|
|
7304
|
+
/**
|
|
7305
|
+
* iPhone deferred deep link match rate: the rolling window ending now.
|
|
7306
|
+
*/
|
|
7307
|
+
export type MatchRatePeriod = '7d' | '30d' | '90d';
|
|
7308
|
+
export interface MatchRatePeriodInfo {
|
|
7309
|
+
'key': '7d' | '30d' | '90d';
|
|
7310
|
+
'from': string;
|
|
7311
|
+
'to': string;
|
|
7312
|
+
}
|
|
6199
7313
|
export interface MatchRejection {
|
|
6200
7314
|
'reason': string;
|
|
6201
7315
|
'text': string;
|
|
@@ -6283,6 +7397,11 @@ export interface Money {
|
|
|
6283
7397
|
'currency': string;
|
|
6284
7398
|
'converted'?: boolean;
|
|
6285
7399
|
}
|
|
7400
|
+
export interface MonthCount {
|
|
7401
|
+
'month': string;
|
|
7402
|
+
'switches': number;
|
|
7403
|
+
'second_phones': number;
|
|
7404
|
+
}
|
|
6286
7405
|
export interface MoveGroupSchema {
|
|
6287
7406
|
'group_id': string;
|
|
6288
7407
|
}
|
|
@@ -6417,9 +7536,10 @@ export interface NewCustomerReferral {
|
|
|
6417
7536
|
}
|
|
6418
7537
|
export type NotApplicableReason = 'app_only' | 'created_after_activity';
|
|
6419
7538
|
/**
|
|
6420
|
-
* What a note is about: the whole organisation, or one campaign, link, app or goal.
|
|
7539
|
+
* What a note is about: the whole organisation, or one campaign, link, app or goal. `panel`: a
|
|
7540
|
+
* note written on one dashboard panel, shown on that panel only.
|
|
6421
7541
|
*/
|
|
6422
|
-
export type NoteScope = 'organization' | 'campaign' | 'link' | 'app' | 'goal';
|
|
7542
|
+
export type NoteScope = 'organization' | 'campaign' | 'link' | 'app' | 'goal' | 'panel';
|
|
6423
7543
|
export type NoteSource = 'member' | 'system';
|
|
6424
7544
|
export type OfflineChannel = 'ussd' | 'sms_keyword' | 'agent' | 'pos' | 'in_store' | 'call_center' | 'event' | 'print' | 'radio' | 'other';
|
|
6425
7545
|
export interface OfflineLocationSchema {
|
|
@@ -6584,6 +7704,34 @@ export interface OrganizationCountriesSchema {
|
|
|
6584
7704
|
'default_allowed_countries'?: Array<string> | null;
|
|
6585
7705
|
'default_block_message'?: string | null;
|
|
6586
7706
|
}
|
|
7707
|
+
export interface OrganizationDeletedEventData {
|
|
7708
|
+
/**
|
|
7709
|
+
* Always null for this event type.
|
|
7710
|
+
*/
|
|
7711
|
+
'previous_attributes': any | null;
|
|
7712
|
+
'object': OrganizationDeletedEventObject;
|
|
7713
|
+
}
|
|
7714
|
+
export interface OrganizationDeletedEventObject {
|
|
7715
|
+
'id': string;
|
|
7716
|
+
'object': 'organization';
|
|
7717
|
+
'deletion_requested_at': string;
|
|
7718
|
+
/**
|
|
7719
|
+
* When the organisation's data is deleted for good.
|
|
7720
|
+
*/
|
|
7721
|
+
'purge_after': string | null;
|
|
7722
|
+
/**
|
|
7723
|
+
* Until when its links show a goodbye page.
|
|
7724
|
+
*/
|
|
7725
|
+
'goodbye_until': string | null;
|
|
7726
|
+
/**
|
|
7727
|
+
* true for live-environment data, false for test mode.
|
|
7728
|
+
*/
|
|
7729
|
+
'livemode': boolean;
|
|
7730
|
+
}
|
|
7731
|
+
export interface OtherMatchCounts {
|
|
7732
|
+
'app_link'?: number;
|
|
7733
|
+
'organic'?: number;
|
|
7734
|
+
}
|
|
6587
7735
|
/**
|
|
6588
7736
|
* POST /v1/referrals/{id}/override: staff, the org owner, or an API key (audit-logged).
|
|
6589
7737
|
*/
|
|
@@ -6665,6 +7813,8 @@ export interface PanelQuerySchema {
|
|
|
6665
7813
|
'explore'?: {
|
|
6666
7814
|
[key: string]: any;
|
|
6667
7815
|
} | null;
|
|
7816
|
+
'funnel_id'?: string | null;
|
|
7817
|
+
'hide_stuck'?: boolean | null;
|
|
6668
7818
|
}
|
|
6669
7819
|
export interface PanelSpecSchema {
|
|
6670
7820
|
'type': PanelType;
|
|
@@ -6706,6 +7856,32 @@ export interface PartnerAnalyticsResponse {
|
|
|
6706
7856
|
*/
|
|
6707
7857
|
'livemode': boolean;
|
|
6708
7858
|
}
|
|
7859
|
+
export interface PartnerApprovedEventData {
|
|
7860
|
+
/**
|
|
7861
|
+
* Always null for this event type.
|
|
7862
|
+
*/
|
|
7863
|
+
'previous_attributes': any | null;
|
|
7864
|
+
'object': PartnerApprovedObject;
|
|
7865
|
+
}
|
|
7866
|
+
/**
|
|
7867
|
+
* A partner who joined a partner programme.
|
|
7868
|
+
*/
|
|
7869
|
+
export interface PartnerApprovedObject {
|
|
7870
|
+
'object': 'partner';
|
|
7871
|
+
'id': string;
|
|
7872
|
+
'program_id': string;
|
|
7873
|
+
'display_name': string | null;
|
|
7874
|
+
'handle': string | null;
|
|
7875
|
+
'external_ref': string | null;
|
|
7876
|
+
'group_id': string;
|
|
7877
|
+
'status': string;
|
|
7878
|
+
'joined_at': string | null;
|
|
7879
|
+
'email': string | null;
|
|
7880
|
+
/**
|
|
7881
|
+
* true for live-environment data, false for test mode.
|
|
7882
|
+
*/
|
|
7883
|
+
'livemode': boolean;
|
|
7884
|
+
}
|
|
6709
7885
|
/**
|
|
6710
7886
|
* A customer partners brought (business only: the business's own customer reference, never to partners).
|
|
6711
7887
|
*/
|
|
@@ -6723,6 +7899,41 @@ export interface PartnerCustomerRow {
|
|
|
6723
7899
|
'earning_window_day': number | null;
|
|
6724
7900
|
'earning_window_days': number | null;
|
|
6725
7901
|
}
|
|
7902
|
+
export interface PartnerEarningApprovedEventData {
|
|
7903
|
+
/**
|
|
7904
|
+
* Always null for this event type.
|
|
7905
|
+
*/
|
|
7906
|
+
'previous_attributes': any | null;
|
|
7907
|
+
'object': PartnerEarningObject;
|
|
7908
|
+
}
|
|
7909
|
+
/**
|
|
7910
|
+
* An approved money earning (store credit and gifts send the partner reward events instead).
|
|
7911
|
+
*/
|
|
7912
|
+
export interface PartnerEarningObject {
|
|
7913
|
+
'object': 'partner_earning';
|
|
7914
|
+
'id': string;
|
|
7915
|
+
'program_id': string;
|
|
7916
|
+
'partner_id': string;
|
|
7917
|
+
/**
|
|
7918
|
+
* Your own reference for the partner, else the partner's ID.
|
|
7919
|
+
*/
|
|
7920
|
+
'partner_reference': string;
|
|
7921
|
+
'partner_display_name': string | null;
|
|
7922
|
+
'kind': string;
|
|
7923
|
+
'amount_minor': number;
|
|
7924
|
+
'currency': string;
|
|
7925
|
+
'goal_key': string | null;
|
|
7926
|
+
'goal_event_id': string | null;
|
|
7927
|
+
'link_id': string | null;
|
|
7928
|
+
'post_tag_id': string | null;
|
|
7929
|
+
'counted_at': string | null;
|
|
7930
|
+
'approved_at': string;
|
|
7931
|
+
'status': string;
|
|
7932
|
+
/**
|
|
7933
|
+
* true for live-environment data, false for test mode.
|
|
7934
|
+
*/
|
|
7935
|
+
'livemode': boolean;
|
|
7936
|
+
}
|
|
6726
7937
|
export interface PartnerEventRow {
|
|
6727
7938
|
'id': string;
|
|
6728
7939
|
'occurred_at': string;
|
|
@@ -6802,6 +8013,31 @@ export interface PartnerMetrics {
|
|
|
6802
8013
|
[key: string]: number;
|
|
6803
8014
|
};
|
|
6804
8015
|
}
|
|
8016
|
+
/**
|
|
8017
|
+
* A payout marked paid in Clikgate (Clikgate never moves money).
|
|
8018
|
+
*/
|
|
8019
|
+
export interface PartnerPayoutObject {
|
|
8020
|
+
'object': 'partner_payout';
|
|
8021
|
+
'id': string;
|
|
8022
|
+
'program_id': string;
|
|
8023
|
+
'period_label': string;
|
|
8024
|
+
'currency': string;
|
|
8025
|
+
'total_minor': number;
|
|
8026
|
+
'partner_count': number;
|
|
8027
|
+
'status': string;
|
|
8028
|
+
'paid_at': string | null;
|
|
8029
|
+
/**
|
|
8030
|
+
* true for live-environment data, false for test mode.
|
|
8031
|
+
*/
|
|
8032
|
+
'livemode': boolean;
|
|
8033
|
+
}
|
|
8034
|
+
export interface PartnerPayoutPaidEventData {
|
|
8035
|
+
/**
|
|
8036
|
+
* Always null for this event type.
|
|
8037
|
+
*/
|
|
8038
|
+
'previous_attributes': any | null;
|
|
8039
|
+
'object': PartnerPayoutObject;
|
|
8040
|
+
}
|
|
6805
8041
|
export interface PartnerProgramInfoResponse {
|
|
6806
8042
|
'id': string;
|
|
6807
8043
|
'object'?: 'partner_program';
|
|
@@ -6845,11 +8081,74 @@ export interface PartnerProgramInfoResponse {
|
|
|
6845
8081
|
*/
|
|
6846
8082
|
'livemode': boolean;
|
|
6847
8083
|
}
|
|
8084
|
+
export interface PartnerRewardEventData {
|
|
8085
|
+
/**
|
|
8086
|
+
* Always null for this event type.
|
|
8087
|
+
*/
|
|
8088
|
+
'previous_attributes': any | null;
|
|
8089
|
+
'object': PartnerRewardObject;
|
|
8090
|
+
}
|
|
8091
|
+
/**
|
|
8092
|
+
* Store credit or a gift a partner earned. Clikgate never applies it: apply it in your own system, then mark it
|
|
8093
|
+
* applied. Never the partner's name or email.
|
|
8094
|
+
*/
|
|
8095
|
+
export interface PartnerRewardObject {
|
|
8096
|
+
'object': 'partner_reward';
|
|
8097
|
+
'earning_id': string;
|
|
8098
|
+
'program_id': string;
|
|
8099
|
+
'partner_id': string;
|
|
8100
|
+
/**
|
|
8101
|
+
* Your own reference for the partner, else the partner's ID.
|
|
8102
|
+
*/
|
|
8103
|
+
'partner_reference': string;
|
|
8104
|
+
/**
|
|
8105
|
+
* `credit` or `gift`.
|
|
8106
|
+
*/
|
|
8107
|
+
'reward_type': string;
|
|
8108
|
+
/**
|
|
8109
|
+
* The credit amount; null for gifts.
|
|
8110
|
+
*/
|
|
8111
|
+
'amount_minor': number | null;
|
|
8112
|
+
'currency': string;
|
|
8113
|
+
/**
|
|
8114
|
+
* The gift; null for credit.
|
|
8115
|
+
*/
|
|
8116
|
+
'gift_name': string | null;
|
|
8117
|
+
/**
|
|
8118
|
+
* The gift's value when one was set; null for credit.
|
|
8119
|
+
*/
|
|
8120
|
+
'gift_value_minor': number | null;
|
|
8121
|
+
'status': string;
|
|
8122
|
+
'reason_code': string | null;
|
|
8123
|
+
'goal_key': string | null;
|
|
8124
|
+
'goal_event_id': string | null;
|
|
8125
|
+
'counted_at': string | null;
|
|
8126
|
+
'reward_batch_id': string | null;
|
|
8127
|
+
/**
|
|
8128
|
+
* `{event type}:{earning id}`: the same reward event is never sent twice.
|
|
8129
|
+
*/
|
|
8130
|
+
'idempotency_key': string;
|
|
8131
|
+
/**
|
|
8132
|
+
* true for live-environment data, false for test mode.
|
|
8133
|
+
*/
|
|
8134
|
+
'livemode': boolean;
|
|
8135
|
+
}
|
|
6848
8136
|
/**
|
|
6849
8137
|
* `invited` (CSV / API import, activated at first sign-in), `applied` (waiting for "approve each new partner").
|
|
6850
8138
|
*/
|
|
6851
8139
|
export type PartnerStatus = 'invited' | 'applied' | 'active' | 'paused' | 'removed';
|
|
6852
8140
|
export type PasteboardMatching = 'off' | 'on_interstitial_tap';
|
|
8141
|
+
/**
|
|
8142
|
+
* First launches by what the iOS SDK's pasteboard step found (`expired` is derived by the server).
|
|
8143
|
+
*/
|
|
8144
|
+
export interface PasteboardOutcomeCounts {
|
|
8145
|
+
'token_found'?: number;
|
|
8146
|
+
'no_link'?: number;
|
|
8147
|
+
'no_token'?: number;
|
|
8148
|
+
'denied'?: number;
|
|
8149
|
+
'paste_control'?: number;
|
|
8150
|
+
'expired'?: number;
|
|
8151
|
+
}
|
|
6853
8152
|
export interface PauseLinkSchema {
|
|
6854
8153
|
'reason'?: string | null;
|
|
6855
8154
|
}
|
|
@@ -6884,6 +8183,24 @@ export interface PaymentConfirmationInfoResponse {
|
|
|
6884
8183
|
*/
|
|
6885
8184
|
'livemode': boolean;
|
|
6886
8185
|
}
|
|
8186
|
+
export interface PaymentEventData {
|
|
8187
|
+
/**
|
|
8188
|
+
* Always null for this event type.
|
|
8189
|
+
*/
|
|
8190
|
+
'previous_attributes': any | null;
|
|
8191
|
+
'object': PaymentReportInfoResponse;
|
|
8192
|
+
}
|
|
8193
|
+
export interface PaymentRefundedEventData {
|
|
8194
|
+
/**
|
|
8195
|
+
* Always null for this event type.
|
|
8196
|
+
*/
|
|
8197
|
+
'previous_attributes': any | null;
|
|
8198
|
+
'object': PaymentReportInfoResponse;
|
|
8199
|
+
/**
|
|
8200
|
+
* The amount refunded by this event, in minor units.
|
|
8201
|
+
*/
|
|
8202
|
+
'refund_amount_minor': number;
|
|
8203
|
+
}
|
|
6887
8204
|
export interface PaymentReportInfoResponse {
|
|
6888
8205
|
'object'?: 'payment_report';
|
|
6889
8206
|
'id': string;
|
|
@@ -7011,6 +8328,8 @@ export interface PeopleIdentifySchema {
|
|
|
7011
8328
|
* Optional label you choose for this person, 1-80 characters after trimming; an empty string clears it. Shown to your team instead of the click ID. Don't put information in labels that your customers wouldn't expect you to keep.
|
|
7012
8329
|
*/
|
|
7013
8330
|
'label'?: string | null;
|
|
8331
|
+
'customer_since'?: string | null;
|
|
8332
|
+
'customer_since_replace'?: boolean;
|
|
7014
8333
|
}
|
|
7015
8334
|
export interface PeopleSearchResponse {
|
|
7016
8335
|
'object'?: 'list';
|
|
@@ -7019,10 +8338,11 @@ export interface PeopleSearchResponse {
|
|
|
7019
8338
|
'next_cursor': string | null;
|
|
7020
8339
|
}
|
|
7021
8340
|
/**
|
|
7022
|
-
* Search text goes in the body, never in the URL, and is never logged.
|
|
8341
|
+
* Search text goes in the body, never in the URL, and is never logged. Empty: the most recently active people.
|
|
7023
8342
|
*/
|
|
7024
8343
|
export interface PeopleSearchSchema {
|
|
7025
|
-
'q'
|
|
8344
|
+
'q'?: string;
|
|
8345
|
+
'segment'?: 'all' | 'new_installs' | 'uninstalled' | 'referrers' | 'referred';
|
|
7026
8346
|
'cursor'?: string | null;
|
|
7027
8347
|
'limit'?: number;
|
|
7028
8348
|
}
|
|
@@ -7055,6 +8375,24 @@ export interface PeriodSummary {
|
|
|
7055
8375
|
'ends_at': string | null;
|
|
7056
8376
|
}
|
|
7057
8377
|
export type PeriodType = 'all_time' | 'daily' | 'weekly' | 'monthly' | 'custom' | 'challenge';
|
|
8378
|
+
/**
|
|
8379
|
+
* The person's latest install of your apps.
|
|
8380
|
+
*/
|
|
8381
|
+
export interface PersonAppSummary {
|
|
8382
|
+
'app_id': string;
|
|
8383
|
+
'platform': string;
|
|
8384
|
+
'installed_at': string;
|
|
8385
|
+
'status': 'installed' | 'uninstalled' | 'unknown';
|
|
8386
|
+
'uninstalled_at': string | null;
|
|
8387
|
+
'reinstall': boolean;
|
|
8388
|
+
}
|
|
8389
|
+
export interface PersonDeviceChangedEventData {
|
|
8390
|
+
/**
|
|
8391
|
+
* Always null for this event type.
|
|
8392
|
+
*/
|
|
8393
|
+
'previous_attributes': any | null;
|
|
8394
|
+
'object': DeviceChangeWebhookObject;
|
|
8395
|
+
}
|
|
7058
8396
|
export interface PersonInfoResponse {
|
|
7059
8397
|
'object'?: 'person';
|
|
7060
8398
|
'id': string;
|
|
@@ -7092,6 +8430,37 @@ export interface PersonRef {
|
|
|
7092
8430
|
'id': string;
|
|
7093
8431
|
'label'?: string | null;
|
|
7094
8432
|
}
|
|
8433
|
+
/**
|
|
8434
|
+
* The referral programme the person refers in (the one with the most qualified friends).
|
|
8435
|
+
*/
|
|
8436
|
+
export interface PersonReferralSummary {
|
|
8437
|
+
'program_id': string;
|
|
8438
|
+
'program_name': string;
|
|
8439
|
+
'referrer_id': string;
|
|
8440
|
+
'code': string | null;
|
|
8441
|
+
'status': string;
|
|
8442
|
+
'installs': number;
|
|
8443
|
+
'qualified': number;
|
|
8444
|
+
'rank': number | null;
|
|
8445
|
+
'rank_board': string | null;
|
|
8446
|
+
'rank_board_id': string | null;
|
|
8447
|
+
'shares': number;
|
|
8448
|
+
'shares_by_app': {
|
|
8449
|
+
[key: string]: number;
|
|
8450
|
+
};
|
|
8451
|
+
}
|
|
8452
|
+
/**
|
|
8453
|
+
* Who brought the person in, when they installed through a referral.
|
|
8454
|
+
*/
|
|
8455
|
+
export interface PersonReferredBySummary {
|
|
8456
|
+
'program_id': string;
|
|
8457
|
+
'program_name': string;
|
|
8458
|
+
'referrer_id': string;
|
|
8459
|
+
'referrer_name': string | null;
|
|
8460
|
+
'code': string | null;
|
|
8461
|
+
'channel': string | null;
|
|
8462
|
+
'status': string;
|
|
8463
|
+
}
|
|
7095
8464
|
/**
|
|
7096
8465
|
* A search result: the label **and** the click ID (labels aren't unique).
|
|
7097
8466
|
*/
|
|
@@ -7106,7 +8475,12 @@ export interface PersonSummaryResponse {
|
|
|
7106
8475
|
'goal_value_minor': {
|
|
7107
8476
|
[key: string]: number;
|
|
7108
8477
|
};
|
|
7109
|
-
'matched_on': 'label' | 'customer_id' | 'click_id';
|
|
8478
|
+
'matched_on': 'label' | 'customer_id' | 'click_id' | null;
|
|
8479
|
+
'app'?: PersonAppSummary | null;
|
|
8480
|
+
'joined_via'?: string | null;
|
|
8481
|
+
'joined_campaign_id'?: string | null;
|
|
8482
|
+
'referrer'?: PersonReferralSummary | null;
|
|
8483
|
+
'referred_by'?: PersonReferredBySummary | null;
|
|
7110
8484
|
/**
|
|
7111
8485
|
* true for live-environment data, false for test mode.
|
|
7112
8486
|
*/
|
|
@@ -7333,6 +8707,34 @@ export interface PreviousIdentitySecretInfo {
|
|
|
7333
8707
|
'stops_at': string;
|
|
7334
8708
|
'status': 'working' | 'stopped';
|
|
7335
8709
|
}
|
|
8710
|
+
/**
|
|
8711
|
+
* The result of a completed export request.
|
|
8712
|
+
*/
|
|
8713
|
+
export interface PrivacyExportResult {
|
|
8714
|
+
/**
|
|
8715
|
+
* A signed link to the JSON file with the subject's data.
|
|
8716
|
+
*/
|
|
8717
|
+
'download_url': string;
|
|
8718
|
+
/**
|
|
8719
|
+
* When the link stops working (Unix seconds).
|
|
8720
|
+
*/
|
|
8721
|
+
'expires_at': number;
|
|
8722
|
+
/**
|
|
8723
|
+
* Installs included.
|
|
8724
|
+
*/
|
|
8725
|
+
'installs': number;
|
|
8726
|
+
/**
|
|
8727
|
+
* Goal events included.
|
|
8728
|
+
*/
|
|
8729
|
+
'goal_name_events': number;
|
|
8730
|
+
}
|
|
8731
|
+
export interface PrivacyRequestEventData {
|
|
8732
|
+
/**
|
|
8733
|
+
* Always null for this event type.
|
|
8734
|
+
*/
|
|
8735
|
+
'previous_attributes': any | null;
|
|
8736
|
+
'object': PrivacyRequestInfoResponse;
|
|
8737
|
+
}
|
|
7336
8738
|
export interface PrivacyRequestInfoResponse {
|
|
7337
8739
|
'id': string;
|
|
7338
8740
|
'object'?: 'privacy_request';
|
|
@@ -7340,9 +8742,7 @@ export interface PrivacyRequestInfoResponse {
|
|
|
7340
8742
|
'type': string;
|
|
7341
8743
|
'subject_type': string;
|
|
7342
8744
|
'status': string;
|
|
7343
|
-
'result':
|
|
7344
|
-
[key: string]: any;
|
|
7345
|
-
} | null;
|
|
8745
|
+
'result': Result | null;
|
|
7346
8746
|
'error': string | null;
|
|
7347
8747
|
'created_at': string;
|
|
7348
8748
|
'completed_at': string | null;
|
|
@@ -7480,6 +8880,21 @@ export interface PushCredentialListResponse {
|
|
|
7480
8880
|
'object'?: 'list';
|
|
7481
8881
|
'data': Array<PushCredentialInfoResponse>;
|
|
7482
8882
|
}
|
|
8883
|
+
export interface PushCredentialsInvalidEventData {
|
|
8884
|
+
/**
|
|
8885
|
+
* Always null for this event type.
|
|
8886
|
+
*/
|
|
8887
|
+
'previous_attributes': any | null;
|
|
8888
|
+
'object': PushCredentialInfoResponse;
|
|
8889
|
+
/**
|
|
8890
|
+
* Why the push provider refused the credentials.
|
|
8891
|
+
*/
|
|
8892
|
+
'provider_reason': string;
|
|
8893
|
+
/**
|
|
8894
|
+
* The provider's HTTP status, when it answered.
|
|
8895
|
+
*/
|
|
8896
|
+
'http_status': number | null;
|
|
8897
|
+
}
|
|
7483
8898
|
export type PushProvider = 'apns' | 'fcm';
|
|
7484
8899
|
export interface PushTestResultResponse {
|
|
7485
8900
|
'object'?: 'push_test_result';
|
|
@@ -7742,6 +9157,33 @@ export interface ReadOnlyCredentialSchema {
|
|
|
7742
9157
|
'client_secret'?: string | null;
|
|
7743
9158
|
'prefix'?: string | null;
|
|
7744
9159
|
}
|
|
9160
|
+
export interface ReceiptEventData {
|
|
9161
|
+
/**
|
|
9162
|
+
* Always null for this event type.
|
|
9163
|
+
*/
|
|
9164
|
+
'previous_attributes': any | null;
|
|
9165
|
+
'object': ReceiptEventObject;
|
|
9166
|
+
}
|
|
9167
|
+
export interface ReceiptEventObject {
|
|
9168
|
+
'object': 'receipt';
|
|
9169
|
+
'id': string;
|
|
9170
|
+
'number': string;
|
|
9171
|
+
'payment_id': string;
|
|
9172
|
+
'invoice_id': string | null;
|
|
9173
|
+
'invoice_number': string | null;
|
|
9174
|
+
'currency': string;
|
|
9175
|
+
'amount_minor': number;
|
|
9176
|
+
'wht_minor': number;
|
|
9177
|
+
'issued_at': string;
|
|
9178
|
+
/**
|
|
9179
|
+
* `issued` or `void`.
|
|
9180
|
+
*/
|
|
9181
|
+
'status': string;
|
|
9182
|
+
/**
|
|
9183
|
+
* true for live-environment data, false for test mode.
|
|
9184
|
+
*/
|
|
9185
|
+
'livemode': boolean;
|
|
9186
|
+
}
|
|
7745
9187
|
/**
|
|
7746
9188
|
* Recent events of one type, newest first, in exactly the delivered envelope (same personal-data gating).
|
|
7747
9189
|
*/
|
|
@@ -7782,6 +9224,13 @@ export interface ReferralErrorInfo {
|
|
|
7782
9224
|
'code': string;
|
|
7783
9225
|
'message': string;
|
|
7784
9226
|
}
|
|
9227
|
+
export interface ReferralEventData {
|
|
9228
|
+
/**
|
|
9229
|
+
* Always null for this event type.
|
|
9230
|
+
*/
|
|
9231
|
+
'previous_attributes': any | null;
|
|
9232
|
+
'object': ReferralInfoResponse;
|
|
9233
|
+
}
|
|
7785
9234
|
/**
|
|
7786
9235
|
* A referral as the API and `referral.*` webhooks show it.
|
|
7787
9236
|
*/
|
|
@@ -7794,33 +9243,26 @@ export interface ReferralInfoResponse {
|
|
|
7794
9243
|
'source': string;
|
|
7795
9244
|
'match_type': string | null;
|
|
7796
9245
|
'current_step': number;
|
|
7797
|
-
'steps_completed': Array<
|
|
7798
|
-
[key: string]: any;
|
|
7799
|
-
}>;
|
|
9246
|
+
'steps_completed': Array<ReferralStepCompletedInfo>;
|
|
7800
9247
|
'step_deadline_at': string | null;
|
|
7801
9248
|
'hold_until': string | null;
|
|
7802
9249
|
'qualified_at': string | null;
|
|
7803
9250
|
'disqualified_at': string | null;
|
|
7804
9251
|
'rejected_at': string | null;
|
|
7805
9252
|
'reason': string | null;
|
|
9253
|
+
'reason_detail'?: string | null;
|
|
9254
|
+
'reason_message'?: string | null;
|
|
7806
9255
|
'fraud_flags': Array<string>;
|
|
7807
9256
|
'referee_uninstalled_after_qualification': boolean;
|
|
7808
|
-
'program':
|
|
7809
|
-
|
|
7810
|
-
|
|
7811
|
-
'
|
|
7812
|
-
[key: string]: any;
|
|
7813
|
-
};
|
|
7814
|
-
'referee': {
|
|
7815
|
-
[key: string]: any;
|
|
7816
|
-
};
|
|
7817
|
-
'link': {
|
|
7818
|
-
[key: string]: any;
|
|
7819
|
-
} | null;
|
|
9257
|
+
'program': ReferralProgramRef;
|
|
9258
|
+
'referrer': ReferralReferrerRef;
|
|
9259
|
+
'referee': ReferralRefereeInfo;
|
|
9260
|
+
'link': ReferralLinkRef | null;
|
|
7820
9261
|
'click_id': string | null;
|
|
7821
|
-
|
|
7822
|
-
|
|
7823
|
-
|
|
9262
|
+
/**
|
|
9263
|
+
* The program's reward as it was when the referral qualified. Absent when there was none.
|
|
9264
|
+
*/
|
|
9265
|
+
'reward_snapshot'?: RewardInfoResponse | null;
|
|
7824
9266
|
'history'?: Array<ReferralStateChangeResponse> | null;
|
|
7825
9267
|
'created_at': string;
|
|
7826
9268
|
'updated_at': string;
|
|
@@ -7829,6 +9271,9 @@ export interface ReferralInfoResponse {
|
|
|
7829
9271
|
*/
|
|
7830
9272
|
'livemode': boolean;
|
|
7831
9273
|
}
|
|
9274
|
+
export interface ReferralLinkRef {
|
|
9275
|
+
'id': string;
|
|
9276
|
+
}
|
|
7832
9277
|
/**
|
|
7833
9278
|
* When a referral programme reward exists for the same goal: the partner earning replaces it, or both count.
|
|
7834
9279
|
*/
|
|
@@ -7860,22 +9305,81 @@ export interface ReferralProgramInfoResponse {
|
|
|
7860
9305
|
'fraud': {
|
|
7861
9306
|
[key: string]: any;
|
|
7862
9307
|
};
|
|
7863
|
-
|
|
7864
|
-
|
|
7865
|
-
|
|
9308
|
+
/**
|
|
9309
|
+
* Reward information for your records. Absent when the program has none.
|
|
9310
|
+
*/
|
|
9311
|
+
'reward'?: RewardInfoResponse | null;
|
|
7866
9312
|
'created_at': string;
|
|
7867
9313
|
'updated_at': string;
|
|
7868
9314
|
/**
|
|
7869
|
-
* true for live-environment data, false for test mode.
|
|
9315
|
+
* true for live-environment data, false for test mode.
|
|
9316
|
+
*/
|
|
9317
|
+
'livemode': boolean;
|
|
9318
|
+
}
|
|
9319
|
+
export interface ReferralProgramRef {
|
|
9320
|
+
'id': string;
|
|
9321
|
+
'name': string;
|
|
9322
|
+
}
|
|
9323
|
+
export interface ReferralRefereeInfo {
|
|
9324
|
+
'install_id': string;
|
|
9325
|
+
'installation_id': string;
|
|
9326
|
+
'customer_user_id': string | null;
|
|
9327
|
+
}
|
|
9328
|
+
export interface ReferralReferrerRef {
|
|
9329
|
+
'id': string;
|
|
9330
|
+
'customer_user_id': string;
|
|
9331
|
+
'code': string;
|
|
9332
|
+
}
|
|
9333
|
+
export interface ReferralStateChangeResponse {
|
|
9334
|
+
'from_status': string | null;
|
|
9335
|
+
'to_status': string;
|
|
9336
|
+
'reason': string | null;
|
|
9337
|
+
'actor': string;
|
|
9338
|
+
'created_at': string;
|
|
9339
|
+
}
|
|
9340
|
+
export interface ReferralStepCompletedEventData {
|
|
9341
|
+
/**
|
|
9342
|
+
* Always null for this event type.
|
|
9343
|
+
*/
|
|
9344
|
+
'previous_attributes': any | null;
|
|
9345
|
+
'object': ReferralInfoResponse;
|
|
9346
|
+
/**
|
|
9347
|
+
* The qualification step just completed (0 is the first).
|
|
9348
|
+
*/
|
|
9349
|
+
'step_index': number;
|
|
9350
|
+
/**
|
|
9351
|
+
* The step's goal key. Absent for identify steps.
|
|
9352
|
+
*/
|
|
9353
|
+
'goal'?: string;
|
|
9354
|
+
/**
|
|
9355
|
+
* true when the step is identifying the customer. Absent for goal steps.
|
|
7870
9356
|
*/
|
|
7871
|
-
'
|
|
9357
|
+
'identify'?: boolean;
|
|
7872
9358
|
}
|
|
7873
|
-
|
|
7874
|
-
|
|
7875
|
-
|
|
7876
|
-
|
|
7877
|
-
|
|
7878
|
-
|
|
9359
|
+
/**
|
|
9360
|
+
* A qualification step the referee completed, in the order they were completed.
|
|
9361
|
+
*/
|
|
9362
|
+
export interface ReferralStepCompletedInfo {
|
|
9363
|
+
/**
|
|
9364
|
+
* The step's position in the program's qualification steps (0 is the first).
|
|
9365
|
+
*/
|
|
9366
|
+
'index': number;
|
|
9367
|
+
/**
|
|
9368
|
+
* The step's goal key. Absent for identify steps.
|
|
9369
|
+
*/
|
|
9370
|
+
'goal'?: string;
|
|
9371
|
+
/**
|
|
9372
|
+
* true for an identify step. Absent for goal steps.
|
|
9373
|
+
*/
|
|
9374
|
+
'identify'?: boolean;
|
|
9375
|
+
/**
|
|
9376
|
+
* When the step was completed (ISO 8601, UTC).
|
|
9377
|
+
*/
|
|
9378
|
+
'completed_at': string;
|
|
9379
|
+
/**
|
|
9380
|
+
* What completed it: `goal:<goal event id>` or `identify:<customer ID>`.
|
|
9381
|
+
*/
|
|
9382
|
+
'source_id'?: string | null;
|
|
7879
9383
|
}
|
|
7880
9384
|
/**
|
|
7881
9385
|
* GET /v1/analytics/referrals/summary: one row per program.
|
|
@@ -7898,6 +9402,13 @@ export interface ReferralSummaryResponse {
|
|
|
7898
9402
|
* an offline code, or a QR scan of the referral link.
|
|
7899
9403
|
*/
|
|
7900
9404
|
export type ReferralTrigger = 'link' | 'code_entry' | 'byo_code' | 'offline_code' | 'qr';
|
|
9405
|
+
export interface ReferrerEventData {
|
|
9406
|
+
/**
|
|
9407
|
+
* Always null for this event type.
|
|
9408
|
+
*/
|
|
9409
|
+
'previous_attributes': any | null;
|
|
9410
|
+
'object': ReferrerInfoResponse;
|
|
9411
|
+
}
|
|
7901
9412
|
export interface ReferrerInfoResponse {
|
|
7902
9413
|
'id': string;
|
|
7903
9414
|
'object'?: 'referrer';
|
|
@@ -7912,9 +9423,7 @@ export interface ReferrerInfoResponse {
|
|
|
7912
9423
|
'status': string;
|
|
7913
9424
|
'blocked_reason': string | null;
|
|
7914
9425
|
'blocked_at': string | null;
|
|
7915
|
-
'stats':
|
|
7916
|
-
[key: string]: any;
|
|
7917
|
-
};
|
|
9426
|
+
'stats': ReferrerStats;
|
|
7918
9427
|
'attributes'?: {
|
|
7919
9428
|
[key: string]: any;
|
|
7920
9429
|
};
|
|
@@ -7929,6 +9438,45 @@ export interface ReferrerInfoResponse {
|
|
|
7929
9438
|
*/
|
|
7930
9439
|
'livemode': boolean;
|
|
7931
9440
|
}
|
|
9441
|
+
export interface ReferrerQualityChangedEventData {
|
|
9442
|
+
/**
|
|
9443
|
+
* Always null for this event type.
|
|
9444
|
+
*/
|
|
9445
|
+
'previous_attributes': any | null;
|
|
9446
|
+
'object': ReferrerInfoResponse;
|
|
9447
|
+
/**
|
|
9448
|
+
* The band before this change (`good`, `watch` or `poor`); null for a referrer's first band.
|
|
9449
|
+
*/
|
|
9450
|
+
'previous_quality_band': string | null;
|
|
9451
|
+
}
|
|
9452
|
+
/**
|
|
9453
|
+
* The referrer's counters, refreshed regularly (not live).
|
|
9454
|
+
*/
|
|
9455
|
+
export interface ReferrerStats {
|
|
9456
|
+
/**
|
|
9457
|
+
* Referrals of any status.
|
|
9458
|
+
*/
|
|
9459
|
+
'installs': number;
|
|
9460
|
+
/**
|
|
9461
|
+
* Referrals past their first qualification step (rejected ones excluded).
|
|
9462
|
+
*/
|
|
9463
|
+
'signups': number;
|
|
9464
|
+
/**
|
|
9465
|
+
* Open referrals.
|
|
9466
|
+
*/
|
|
9467
|
+
'in_progress': number;
|
|
9468
|
+
'qualified': number;
|
|
9469
|
+
'disqualified': number;
|
|
9470
|
+
'rejected': number;
|
|
9471
|
+
/**
|
|
9472
|
+
* Human clicks on the referrer's link (code URLs count as the link).
|
|
9473
|
+
*/
|
|
9474
|
+
'clicks': number;
|
|
9475
|
+
/**
|
|
9476
|
+
* Share of referees (0 to 1) who uninstalled within 7 days; null when none is old enough yet. Absent until the counters are first refreshed.
|
|
9477
|
+
*/
|
|
9478
|
+
'referee_uninstall_rate_7d'?: number | null;
|
|
9479
|
+
}
|
|
7932
9480
|
/**
|
|
7933
9481
|
* "{n} calls were refused this week because the goal isn't set up: {top names}" (the last 7 days,
|
|
7934
9482
|
* Lagos time). Shown as soon as any call is refused, whether or not a goal has been counted.
|
|
@@ -8187,6 +9735,12 @@ export interface ResolveReportSchema {
|
|
|
8187
9735
|
'note'?: string | null;
|
|
8188
9736
|
}
|
|
8189
9737
|
export type ResponseReportConversionV1ConversionsPost = ConversionInfoResponse | GoalEventInfoResponse;
|
|
9738
|
+
/**
|
|
9739
|
+
* Set once the request has completed: the export's link, or the erasure's counts.
|
|
9740
|
+
*/
|
|
9741
|
+
export type Result = PrivacyExportResult | {
|
|
9742
|
+
[key: string]: number;
|
|
9743
|
+
};
|
|
8190
9744
|
export interface ResultPoint {
|
|
8191
9745
|
'day': string;
|
|
8192
9746
|
'variant_id': string;
|
|
@@ -8197,15 +9751,15 @@ export interface RetentionCohort {
|
|
|
8197
9751
|
'cohort': string;
|
|
8198
9752
|
'cohort_size': number;
|
|
8199
9753
|
'flagged_installs': number;
|
|
8200
|
-
'retained': Array<
|
|
8201
|
-
'retention': Array<
|
|
9754
|
+
'retained': Array<CurveInner>;
|
|
9755
|
+
'retention': Array<ChangePctValue>;
|
|
8202
9756
|
}
|
|
8203
9757
|
export type RetentionGrain = 'day' | 'week';
|
|
8204
9758
|
export interface RetentionGroup {
|
|
8205
9759
|
'key': string | null;
|
|
8206
9760
|
'cohort_size': number;
|
|
8207
9761
|
'flagged_installs': number;
|
|
8208
|
-
'retention': Array<
|
|
9762
|
+
'retention': Array<ChangePctValue>;
|
|
8209
9763
|
'cohorts': Array<RetentionCohort>;
|
|
8210
9764
|
}
|
|
8211
9765
|
export type RetentionGroupBy = 'none' | 'acquired_via' | 'campaign' | 'creator' | 'partner' | 'platform' | 'country';
|
|
@@ -8233,7 +9787,20 @@ export interface RetentionResponse {
|
|
|
8233
9787
|
export interface RetentionTotals {
|
|
8234
9788
|
'cohort_size': number;
|
|
8235
9789
|
'flagged_installs': number;
|
|
8236
|
-
'retention': Array<
|
|
9790
|
+
'retention': Array<ChangePctValue>;
|
|
9791
|
+
}
|
|
9792
|
+
export interface ReversalInfoResponse {
|
|
9793
|
+
'id': string;
|
|
9794
|
+
'object'?: 'conversion_reversal';
|
|
9795
|
+
'conversion_id': string;
|
|
9796
|
+
'amount_minor': number;
|
|
9797
|
+
'reason': string | null;
|
|
9798
|
+
'external_id': string | null;
|
|
9799
|
+
'created_at': string;
|
|
9800
|
+
/**
|
|
9801
|
+
* true for live-environment data, false for test mode.
|
|
9802
|
+
*/
|
|
9803
|
+
'livemode': boolean;
|
|
8237
9804
|
}
|
|
8238
9805
|
export interface ReverseConversionSchema {
|
|
8239
9806
|
'amount_minor'?: number | null;
|
|
@@ -8306,11 +9873,40 @@ export interface RewardInfo {
|
|
|
8306
9873
|
'referee'?: RewardSide | null;
|
|
8307
9874
|
'note'?: string | null;
|
|
8308
9875
|
}
|
|
9876
|
+
/**
|
|
9877
|
+
* Reward information, for your records only: Clikgate never pays rewards. Keys without a value are left out
|
|
9878
|
+
* (a side can be an empty object).
|
|
9879
|
+
*/
|
|
9880
|
+
export interface RewardInfoResponse {
|
|
9881
|
+
'referrer'?: RewardSideResponse;
|
|
9882
|
+
'referee'?: RewardSideResponse;
|
|
9883
|
+
/**
|
|
9884
|
+
* A note shown with the reward. Absent when not set.
|
|
9885
|
+
*/
|
|
9886
|
+
'note'?: string;
|
|
9887
|
+
}
|
|
8309
9888
|
export interface RewardSide {
|
|
8310
9889
|
'amount_minor'?: number | null;
|
|
8311
9890
|
'currency'?: string | null;
|
|
8312
9891
|
'description'?: string | null;
|
|
8313
9892
|
}
|
|
9893
|
+
/**
|
|
9894
|
+
* One side's reward. Keys without a value are left out.
|
|
9895
|
+
*/
|
|
9896
|
+
export interface RewardSideResponse {
|
|
9897
|
+
/**
|
|
9898
|
+
* The amount in minor units. Absent when not set.
|
|
9899
|
+
*/
|
|
9900
|
+
'amount_minor'?: number;
|
|
9901
|
+
/**
|
|
9902
|
+
* ISO 4217 code, present with `amount_minor`. Absent when not set.
|
|
9903
|
+
*/
|
|
9904
|
+
'currency'?: string;
|
|
9905
|
+
/**
|
|
9906
|
+
* The reward in words. Absent when not set.
|
|
9907
|
+
*/
|
|
9908
|
+
'description'?: string;
|
|
9909
|
+
}
|
|
8314
9910
|
/**
|
|
8315
9911
|
* What a rule (and its earnings) gives. `money` is paid in a payout; `credit` (an amount in the
|
|
8316
9912
|
* programme currency) and `gift` (a description) are applied by the business in its own system and end `applied`.
|
|
@@ -8420,6 +10016,13 @@ export interface SaleDetailResponse {
|
|
|
8420
10016
|
*/
|
|
8421
10017
|
'livemode': boolean;
|
|
8422
10018
|
}
|
|
10019
|
+
export interface SaleEventData {
|
|
10020
|
+
/**
|
|
10021
|
+
* Always null for this event type.
|
|
10022
|
+
*/
|
|
10023
|
+
'previous_attributes': any | null;
|
|
10024
|
+
'object': SaleInfoResponse;
|
|
10025
|
+
}
|
|
8423
10026
|
export interface SaleInfoResponse {
|
|
8424
10027
|
'id': string;
|
|
8425
10028
|
'object'?: 'sale';
|
|
@@ -8452,6 +10055,17 @@ export interface SaleInstallInfo {
|
|
|
8452
10055
|
'app_version': string | null;
|
|
8453
10056
|
'country': string | null;
|
|
8454
10057
|
}
|
|
10058
|
+
export interface SaleRefundedEventData {
|
|
10059
|
+
/**
|
|
10060
|
+
* Always null for this event type.
|
|
10061
|
+
*/
|
|
10062
|
+
'previous_attributes': any | null;
|
|
10063
|
+
'object': SaleInfoResponse;
|
|
10064
|
+
/**
|
|
10065
|
+
* The amount refunded by this event, in minor units.
|
|
10066
|
+
*/
|
|
10067
|
+
'refund_amount_minor': number;
|
|
10068
|
+
}
|
|
8455
10069
|
export interface SaleTimelineStep {
|
|
8456
10070
|
'kind': 'click' | 'install' | 'goal' | 'purchase' | 'refund';
|
|
8457
10071
|
'at': string;
|
|
@@ -8743,7 +10357,7 @@ export interface SendDomainSetupSchema {
|
|
|
8743
10357
|
'email': string;
|
|
8744
10358
|
'note'?: string | null;
|
|
8745
10359
|
}
|
|
8746
|
-
export type SendStatus = 'queued' | 'sent' | 'failed' | 'skipped_fraud' | 'skipped_no_click_id' | 'skipped_probabilistic' | 'skipped_consent' | 'skipped_not_supported' | 'skipped_plan' | 'skipped_unconfirmed' | 'skipped_reversed' | 'skipped_disputed' | 'skipped_window_passed' | 'skipped_partner_handles_app' | 'skipped_business_messaging';
|
|
10360
|
+
export type SendStatus = 'queued' | 'sent' | 'failed' | 'skipped_fraud' | 'skipped_no_click_id' | 'skipped_probabilistic' | 'skipped_consent' | 'skipped_not_supported' | 'skipped_plan' | 'skipped_unconfirmed' | 'skipped_reversed' | 'skipped_disputed' | 'skipped_window_passed' | 'skipped_partner_handles_app' | 'skipped_business_messaging' | 'skipped_existing_user';
|
|
8747
10361
|
/**
|
|
8748
10362
|
* `consent` on `POST /v1/conversions` and sales: the four purposes and an optional region.
|
|
8749
10363
|
*/
|
|
@@ -8970,6 +10584,41 @@ export interface SignalInput {
|
|
|
8970
10584
|
'hash': string;
|
|
8971
10585
|
'verified'?: boolean;
|
|
8972
10586
|
}
|
|
10587
|
+
export interface SkanPostbackEventData {
|
|
10588
|
+
/**
|
|
10589
|
+
* Always null for this event type.
|
|
10590
|
+
*/
|
|
10591
|
+
'previous_attributes': any | null;
|
|
10592
|
+
'object': SkanPostbackInfoResponse;
|
|
10593
|
+
}
|
|
10594
|
+
export interface SkanPostbackInfoResponse {
|
|
10595
|
+
'id': string;
|
|
10596
|
+
'object'?: 'skan_postback';
|
|
10597
|
+
'app_id': string | null;
|
|
10598
|
+
'kind': string;
|
|
10599
|
+
'version': string | null;
|
|
10600
|
+
'ad_network_id': string | null;
|
|
10601
|
+
'source_identifier': string | null;
|
|
10602
|
+
'source_app_id': string | null;
|
|
10603
|
+
'source_domain': string | null;
|
|
10604
|
+
'fine_conversion_value': number | null;
|
|
10605
|
+
'coarse_conversion_value': string | null;
|
|
10606
|
+
'postback_sequence_index': number | null;
|
|
10607
|
+
'did_win': boolean | null;
|
|
10608
|
+
'redownload': boolean | null;
|
|
10609
|
+
'signature_verified': boolean;
|
|
10610
|
+
'source'?: string;
|
|
10611
|
+
'signature_ok'?: boolean | null;
|
|
10612
|
+
'schema_id': string | null;
|
|
10613
|
+
'decoded': {
|
|
10614
|
+
[key: string]: any;
|
|
10615
|
+
} | null;
|
|
10616
|
+
'received_at': string;
|
|
10617
|
+
/**
|
|
10618
|
+
* true for live-environment data, false for test mode.
|
|
10619
|
+
*/
|
|
10620
|
+
'livemode': boolean;
|
|
10621
|
+
}
|
|
8973
10622
|
export interface SkanReportResponse {
|
|
8974
10623
|
'object'?: 'skan_report';
|
|
8975
10624
|
'app_id': string;
|
|
@@ -9306,6 +10955,90 @@ export interface SubjectRef {
|
|
|
9306
10955
|
'id': string;
|
|
9307
10956
|
}
|
|
9308
10957
|
export type SubjectType = 'customer_user_id' | 'installation_id' | 'external_customer_id';
|
|
10958
|
+
export interface SubscriptionAddOnEventItem {
|
|
10959
|
+
'key': string;
|
|
10960
|
+
'name': string;
|
|
10961
|
+
'status': string;
|
|
10962
|
+
'quantity': number;
|
|
10963
|
+
/**
|
|
10964
|
+
* The add-on's price for the billing period; null on custom billing.
|
|
10965
|
+
*/
|
|
10966
|
+
'amount_minor': number | null;
|
|
10967
|
+
'ends_at': string | null;
|
|
10968
|
+
'remove_at_renewal': boolean;
|
|
10969
|
+
}
|
|
10970
|
+
export interface SubscriptionChangedEventData {
|
|
10971
|
+
'object': SubscriptionEventObject;
|
|
10972
|
+
'previous_attributes': SubscriptionChangedPreviousAttributes;
|
|
10973
|
+
}
|
|
10974
|
+
export interface SubscriptionChangedPreviousAttributes {
|
|
10975
|
+
/**
|
|
10976
|
+
* The plan of the subscription this one replaced.
|
|
10977
|
+
*/
|
|
10978
|
+
'plan_key': string;
|
|
10979
|
+
/**
|
|
10980
|
+
* That subscription's status.
|
|
10981
|
+
*/
|
|
10982
|
+
'status': string;
|
|
10983
|
+
}
|
|
10984
|
+
export interface SubscriptionEventData {
|
|
10985
|
+
/**
|
|
10986
|
+
* Always null for this event type.
|
|
10987
|
+
*/
|
|
10988
|
+
'previous_attributes': any | null;
|
|
10989
|
+
'object': SubscriptionEventObject;
|
|
10990
|
+
}
|
|
10991
|
+
export interface SubscriptionEventObject {
|
|
10992
|
+
'object': 'subscription';
|
|
10993
|
+
'id': string;
|
|
10994
|
+
'plan_key': string;
|
|
10995
|
+
'plan_name': string | null;
|
|
10996
|
+
'plan_version_id': string;
|
|
10997
|
+
'status': string;
|
|
10998
|
+
'billing_period': string;
|
|
10999
|
+
'currency': string;
|
|
11000
|
+
'amount_minor': number;
|
|
11001
|
+
'current_period_start': string;
|
|
11002
|
+
'current_period_end': string;
|
|
11003
|
+
'grace_until': string | null;
|
|
11004
|
+
'cancel_at': string | null;
|
|
11005
|
+
/**
|
|
11006
|
+
* true for live-environment data, false for test mode.
|
|
11007
|
+
*/
|
|
11008
|
+
'livemode': boolean;
|
|
11009
|
+
}
|
|
11010
|
+
export interface SubscriptionUpdatedEventData {
|
|
11011
|
+
/**
|
|
11012
|
+
* Always null for this event type.
|
|
11013
|
+
*/
|
|
11014
|
+
'previous_attributes': any | null;
|
|
11015
|
+
'object': SubscriptionWithAddOnsEventObject;
|
|
11016
|
+
/**
|
|
11017
|
+
* `add_on.activated`, `add_on.remove_at_renewal` or `add_on.quantity_changed`.
|
|
11018
|
+
*/
|
|
11019
|
+
'change': string;
|
|
11020
|
+
'add_on_key': string;
|
|
11021
|
+
}
|
|
11022
|
+
export interface SubscriptionWithAddOnsEventObject {
|
|
11023
|
+
'object': 'subscription';
|
|
11024
|
+
'id': string;
|
|
11025
|
+
'plan_key': string;
|
|
11026
|
+
'plan_name': string | null;
|
|
11027
|
+
'plan_version_id': string;
|
|
11028
|
+
'status': string;
|
|
11029
|
+
'billing_period': string;
|
|
11030
|
+
'currency': string;
|
|
11031
|
+
'amount_minor': number;
|
|
11032
|
+
'current_period_start': string;
|
|
11033
|
+
'current_period_end': string;
|
|
11034
|
+
'grace_until': string | null;
|
|
11035
|
+
'cancel_at': string | null;
|
|
11036
|
+
'add_ons': Array<SubscriptionAddOnEventItem>;
|
|
11037
|
+
/**
|
|
11038
|
+
* true for live-environment data, false for test mode.
|
|
11039
|
+
*/
|
|
11040
|
+
'livemode': boolean;
|
|
11041
|
+
}
|
|
9309
11042
|
/**
|
|
9310
11043
|
* One proposed group: its name, the ungrouped goals it would take, and the existing group of that name if any.
|
|
9311
11044
|
*/
|
|
@@ -9568,6 +11301,48 @@ export interface TravelledResponse {
|
|
|
9568
11301
|
'shared_as': SharedAs;
|
|
9569
11302
|
'clicks': number;
|
|
9570
11303
|
}
|
|
11304
|
+
export type TrendInner = CustomerCostPeriod;
|
|
11305
|
+
export interface TrialEventData {
|
|
11306
|
+
/**
|
|
11307
|
+
* Always null for this event type.
|
|
11308
|
+
*/
|
|
11309
|
+
'previous_attributes': any | null;
|
|
11310
|
+
'object': TrialSubscriptionEventObject;
|
|
11311
|
+
}
|
|
11312
|
+
export interface TrialEventInfo {
|
|
11313
|
+
'id': string;
|
|
11314
|
+
'plan_key': string;
|
|
11315
|
+
'status': string;
|
|
11316
|
+
'started_at': string;
|
|
11317
|
+
'ends_at': string;
|
|
11318
|
+
}
|
|
11319
|
+
/**
|
|
11320
|
+
* The trial's subscription (its keys are absent when the trial has none) and the trial's dates.
|
|
11321
|
+
*/
|
|
11322
|
+
export interface TrialSubscriptionEventObject {
|
|
11323
|
+
'object': 'subscription';
|
|
11324
|
+
'id'?: string | null;
|
|
11325
|
+
'plan_key'?: string | null;
|
|
11326
|
+
'plan_name'?: string | null;
|
|
11327
|
+
'plan_version_id'?: string | null;
|
|
11328
|
+
'status'?: string | null;
|
|
11329
|
+
'billing_period'?: string | null;
|
|
11330
|
+
'currency'?: string | null;
|
|
11331
|
+
'amount_minor'?: number | null;
|
|
11332
|
+
'current_period_start'?: string | null;
|
|
11333
|
+
'current_period_end'?: string | null;
|
|
11334
|
+
'grace_until'?: string | null;
|
|
11335
|
+
'cancel_at'?: string | null;
|
|
11336
|
+
'trial': TrialEventInfo;
|
|
11337
|
+
/**
|
|
11338
|
+
* The trial's new end (`subscription.trial_extended` only).
|
|
11339
|
+
*/
|
|
11340
|
+
'new_end'?: string | null;
|
|
11341
|
+
/**
|
|
11342
|
+
* true for live-environment data, false for test mode.
|
|
11343
|
+
*/
|
|
11344
|
+
'livemode': boolean;
|
|
11345
|
+
}
|
|
9571
11346
|
export interface TrophyBand {
|
|
9572
11347
|
'key': string;
|
|
9573
11348
|
'label': string;
|
|
@@ -9613,14 +11388,23 @@ export interface UninstallMeasures {
|
|
|
9613
11388
|
* Installs whose first open is in the period (the cohort)
|
|
9614
11389
|
*/
|
|
9615
11390
|
'installs': number;
|
|
11391
|
+
'existing_user_uninstalls'?: number;
|
|
9616
11392
|
/**
|
|
9617
11393
|
* Cohort installs Clikgate can check (push token, not opted out)
|
|
9618
11394
|
*/
|
|
9619
11395
|
'tracked_installs': number;
|
|
11396
|
+
/**
|
|
11397
|
+
* Checked installs ÷ installs (0-1, 4 dp): the share of the cohort the rates cover; null with no installs
|
|
11398
|
+
*/
|
|
11399
|
+
'coverage'?: number | null;
|
|
9620
11400
|
/**
|
|
9621
11401
|
* Uninstalls detected in the period
|
|
9622
11402
|
*/
|
|
9623
11403
|
'uninstalls': number;
|
|
11404
|
+
/**
|
|
11405
|
+
* Cohort installs whose uninstall was later reversed because the app opened again (a reinstall that kept the installation id, or a stale push token)
|
|
11406
|
+
*/
|
|
11407
|
+
'uninstalls_reverted'?: number;
|
|
9624
11408
|
'uninstall_rate_d1'?: number | null;
|
|
9625
11409
|
'uninstall_rate_d7'?: number | null;
|
|
9626
11410
|
'uninstall_rate_d30'?: number | null;
|
|
@@ -9681,14 +11465,23 @@ export interface UninstallReportRow {
|
|
|
9681
11465
|
* Installs whose first open is in the period (the cohort)
|
|
9682
11466
|
*/
|
|
9683
11467
|
'installs': number;
|
|
11468
|
+
'existing_user_uninstalls'?: number;
|
|
9684
11469
|
/**
|
|
9685
11470
|
* Cohort installs Clikgate can check (push token, not opted out)
|
|
9686
11471
|
*/
|
|
9687
11472
|
'tracked_installs': number;
|
|
11473
|
+
/**
|
|
11474
|
+
* Checked installs ÷ installs (0-1, 4 dp): the share of the cohort the rates cover; null with no installs
|
|
11475
|
+
*/
|
|
11476
|
+
'coverage'?: number | null;
|
|
9688
11477
|
/**
|
|
9689
11478
|
* Uninstalls detected in the period
|
|
9690
11479
|
*/
|
|
9691
11480
|
'uninstalls': number;
|
|
11481
|
+
/**
|
|
11482
|
+
* Cohort installs whose uninstall was later reversed because the app opened again (a reinstall that kept the installation id, or a stale push token)
|
|
11483
|
+
*/
|
|
11484
|
+
'uninstalls_reverted'?: number;
|
|
9692
11485
|
'uninstall_rate_d1'?: number | null;
|
|
9693
11486
|
'uninstall_rate_d7'?: number | null;
|
|
9694
11487
|
'uninstall_rate_d30'?: number | null;
|
|
@@ -10335,13 +12128,40 @@ export interface UsageInfoResponse {
|
|
|
10335
12128
|
'livemode'?: boolean;
|
|
10336
12129
|
'plan': string;
|
|
10337
12130
|
'limits': {
|
|
10338
|
-
[key: string]:
|
|
12131
|
+
[key: string]: CurveInner;
|
|
10339
12132
|
};
|
|
10340
12133
|
'data': Array<UsageDayResponse>;
|
|
10341
12134
|
'totals': {
|
|
10342
12135
|
[key: string]: number;
|
|
10343
12136
|
};
|
|
10344
12137
|
}
|
|
12138
|
+
export interface UsageThresholdEventData {
|
|
12139
|
+
/**
|
|
12140
|
+
* Always null for this event type.
|
|
12141
|
+
*/
|
|
12142
|
+
'previous_attributes': any | null;
|
|
12143
|
+
'object': UsageThresholdEventObject;
|
|
12144
|
+
}
|
|
12145
|
+
export interface UsageThresholdEventObject {
|
|
12146
|
+
'object': 'usage_threshold';
|
|
12147
|
+
'meter': string;
|
|
12148
|
+
/**
|
|
12149
|
+
* 80 or 100.
|
|
12150
|
+
*/
|
|
12151
|
+
'percent': number;
|
|
12152
|
+
'allowance': number | null;
|
|
12153
|
+
'used': number;
|
|
12154
|
+
'period_start': string;
|
|
12155
|
+
'plan_key': string;
|
|
12156
|
+
/**
|
|
12157
|
+
* Whether usage above the allowance is billed as extra usage.
|
|
12158
|
+
*/
|
|
12159
|
+
'overage_priced': boolean;
|
|
12160
|
+
/**
|
|
12161
|
+
* true for live-environment data, false for test mode.
|
|
12162
|
+
*/
|
|
12163
|
+
'livemode': boolean;
|
|
12164
|
+
}
|
|
10345
12165
|
export type ValidationMessagesInnerValue = number | string;
|
|
10346
12166
|
/**
|
|
10347
12167
|
* Normal units, never minor units (₦2,000,000 is 2000000; decimals allowed up to the currency's ISO 4217 exponent): a JSON number or a numeric string, ≥ 0, at most 15 significant digits.
|
|
@@ -10432,6 +12252,13 @@ export interface WebhookDeliveryListResponse {
|
|
|
10432
12252
|
'object'?: 'list';
|
|
10433
12253
|
'data': Array<WebhookDeliveryInfoResponse>;
|
|
10434
12254
|
}
|
|
12255
|
+
export interface WebhookEndpointEventData {
|
|
12256
|
+
/**
|
|
12257
|
+
* Always null for this event type.
|
|
12258
|
+
*/
|
|
12259
|
+
'previous_attributes': any | null;
|
|
12260
|
+
'object': WebhookEndpointInfoResponse;
|
|
12261
|
+
}
|
|
10435
12262
|
export interface WebhookEndpointInfoResponse {
|
|
10436
12263
|
'id': string;
|
|
10437
12264
|
'object'?: 'webhook_endpoint';
|
|
@@ -10455,6 +12282,16 @@ export interface WebhookEndpointInfoResponse {
|
|
|
10455
12282
|
*/
|
|
10456
12283
|
'livemode': boolean;
|
|
10457
12284
|
}
|
|
12285
|
+
export interface WebhookTestEventData {
|
|
12286
|
+
/**
|
|
12287
|
+
* Always null for this event type.
|
|
12288
|
+
*/
|
|
12289
|
+
'previous_attributes': any | null;
|
|
12290
|
+
'object': WebhookTestEventObject;
|
|
12291
|
+
}
|
|
12292
|
+
export interface WebhookTestEventObject {
|
|
12293
|
+
'message': 'test';
|
|
12294
|
+
}
|
|
10458
12295
|
/**
|
|
10459
12296
|
* This month's installs from banner taps (organisation timezone), shown as "no ad spend".
|
|
10460
12297
|
*/
|
|
@@ -10558,6 +12395,13 @@ export interface WhatsappContactSchema {
|
|
|
10558
12395
|
'phone_e164'?: string | null;
|
|
10559
12396
|
'contact_hash'?: string | null;
|
|
10560
12397
|
}
|
|
12398
|
+
export interface WhatsappConversationAttributedEventData {
|
|
12399
|
+
/**
|
|
12400
|
+
* Always null for this event type.
|
|
12401
|
+
*/
|
|
12402
|
+
'previous_attributes': any | null;
|
|
12403
|
+
'object': WhatsappConversationWebhookObject;
|
|
12404
|
+
}
|
|
10561
12405
|
export interface WhatsappConversationInfoResponse {
|
|
10562
12406
|
'id': string;
|
|
10563
12407
|
'object'?: 'whatsapp_conversation';
|
|
@@ -10582,6 +12426,34 @@ export interface WhatsappConversationInfoResponse {
|
|
|
10582
12426
|
*/
|
|
10583
12427
|
'livemode': boolean;
|
|
10584
12428
|
}
|
|
12429
|
+
/**
|
|
12430
|
+
* The conversation, with the full keyed contact hash so it can be sent back with conversions.
|
|
12431
|
+
*/
|
|
12432
|
+
export interface WhatsappConversationWebhookObject {
|
|
12433
|
+
'id': string;
|
|
12434
|
+
'object'?: 'whatsapp_conversation';
|
|
12435
|
+
'channel_id': string;
|
|
12436
|
+
'contact_hash_prefix': string;
|
|
12437
|
+
'ref': string | null;
|
|
12438
|
+
'click_id': string | null;
|
|
12439
|
+
'link_id': string | null;
|
|
12440
|
+
'campaign_id': string | null;
|
|
12441
|
+
'attributed': boolean;
|
|
12442
|
+
'attribution_method': string;
|
|
12443
|
+
'first_message_at': string;
|
|
12444
|
+
'last_message_at': string | null;
|
|
12445
|
+
'created_at': string;
|
|
12446
|
+
'ad_platform'?: string | null;
|
|
12447
|
+
'ad_id'?: string | null;
|
|
12448
|
+
'ad_adset_id'?: string | null;
|
|
12449
|
+
'ad_campaign_id'?: string | null;
|
|
12450
|
+
'ad_referral_at'?: string | null;
|
|
12451
|
+
'contact_hash': string;
|
|
12452
|
+
/**
|
|
12453
|
+
* true for live-environment data, false for test mode.
|
|
12454
|
+
*/
|
|
12455
|
+
'livemode': boolean;
|
|
12456
|
+
}
|
|
10585
12457
|
export interface WinnerSignalResponse {
|
|
10586
12458
|
'status': string;
|
|
10587
12459
|
'message': string;
|
|
@@ -11384,6 +13256,19 @@ export declare class AnalyticsApi {
|
|
|
11384
13256
|
dataFreshness(query?: {
|
|
11385
13257
|
'sources'?: string | null;
|
|
11386
13258
|
}, options?: RequestOptions): Promise<FreshnessResponse>;
|
|
13259
|
+
/**
|
|
13260
|
+
* Device Changes Report
|
|
13261
|
+
*
|
|
13262
|
+
* `GET /v1/analytics/device-changes`
|
|
13263
|
+
*
|
|
13264
|
+
* @example
|
|
13265
|
+
* await clikgate.api.analytics.deviceChangesReport();
|
|
13266
|
+
*/
|
|
13267
|
+
deviceChangesReport(query?: {
|
|
13268
|
+
'from'?: string | null;
|
|
13269
|
+
'to'?: string | null;
|
|
13270
|
+
'app_id'?: string | null;
|
|
13271
|
+
}, options?: RequestOptions): Promise<DeviceChangesReportResponse>;
|
|
11387
13272
|
/**
|
|
11388
13273
|
* Explore
|
|
11389
13274
|
*
|
|
@@ -12059,6 +13944,19 @@ export declare class AppsApi {
|
|
|
12059
13944
|
* await clikgate.api.apps.fetchSdkHealth('app_…');
|
|
12060
13945
|
*/
|
|
12061
13946
|
fetchSdkHealth(appId: string, options?: RequestOptions): Promise<SdkHealthResponse>;
|
|
13947
|
+
/**
|
|
13948
|
+
* Iphone Deferred Deep Link Match Rate
|
|
13949
|
+
*
|
|
13950
|
+
* iOS first launches in the period (rolling, ending now) and what the iOS SDK's pasteboard step found: `attempted` (the paste flow ran), `matched` (attributed by the pasteboard token), `match_rate` (matched / attempted, `null` when nothing was attempted) and the outcome breakdown. Measured, never estimated. iOS apps only: an Android app answers 422 `platform_not_ios`.
|
|
13951
|
+
*
|
|
13952
|
+
* `GET /v1/apps/{app_id}/iphone-deferred-match-rate`
|
|
13953
|
+
*
|
|
13954
|
+
* @example
|
|
13955
|
+
* await clikgate.api.apps.iphoneDeferredDeepLinkMatchRate('app_…');
|
|
13956
|
+
*/
|
|
13957
|
+
iphoneDeferredDeepLinkMatchRate(appId: string, query?: {
|
|
13958
|
+
'period'?: MatchRatePeriod | null;
|
|
13959
|
+
}, options?: RequestOptions): Promise<DeferredMatchRateResponse>;
|
|
12062
13960
|
/**
|
|
12063
13961
|
* Link Subdomain Availability
|
|
12064
13962
|
*
|
|
@@ -14310,6 +16208,30 @@ export declare class JobsApi {
|
|
|
14310
16208
|
*/
|
|
14311
16209
|
fetchJob(jobId: string, options?: RequestOptions): Promise<JobInfoResponse>;
|
|
14312
16210
|
}
|
|
16211
|
+
/**
|
|
16212
|
+
* KnownCustomers: generated from openapi.json. See https://clikgate.com/docs/api.
|
|
16213
|
+
*/
|
|
16214
|
+
export declare class KnownCustomersApi {
|
|
16215
|
+
private readonly r;
|
|
16216
|
+
/**
|
|
16217
|
+
* Import Known Customers
|
|
16218
|
+
*
|
|
16219
|
+
* `POST /v1/known-customers/import`
|
|
16220
|
+
*
|
|
16221
|
+
* @example
|
|
16222
|
+
* await clikgate.api.knownCustomers.importKnownCustomers({ … });
|
|
16223
|
+
*/
|
|
16224
|
+
importKnownCustomers(body: KnownCustomersImportSchema, options?: RequestOptions): Promise<KnownCustomersImportResponse>;
|
|
16225
|
+
/**
|
|
16226
|
+
* Remove Known Customer
|
|
16227
|
+
*
|
|
16228
|
+
* `POST /v1/known-customers/remove`
|
|
16229
|
+
*
|
|
16230
|
+
* @example
|
|
16231
|
+
* await clikgate.api.knownCustomers.removeKnownCustomer({ … });
|
|
16232
|
+
*/
|
|
16233
|
+
removeKnownCustomer(body: KnownCustomerRemoveSchema, options?: RequestOptions): Promise<KnownCustomerRemoveResponse>;
|
|
16234
|
+
}
|
|
14313
16235
|
/**
|
|
14314
16236
|
* Leaderboards: generated from openapi.json. See https://clikgate.com/docs/api.
|
|
14315
16237
|
*/
|
|
@@ -16085,6 +18007,15 @@ export declare class PeopleApi {
|
|
|
16085
18007
|
* await clikgate.api.people.fetchPerson('<person_id>');
|
|
16086
18008
|
*/
|
|
16087
18009
|
fetchPerson(personId: string, options?: RequestOptions): Promise<PersonInfoResponse>;
|
|
18010
|
+
/**
|
|
18011
|
+
* Fetch Person Device Changes
|
|
18012
|
+
*
|
|
18013
|
+
* `GET /v1/people/{person_id}/device-changes`
|
|
18014
|
+
*
|
|
18015
|
+
* @example
|
|
18016
|
+
* await clikgate.api.people.fetchPersonDeviceChanges('<person_id>');
|
|
18017
|
+
*/
|
|
18018
|
+
fetchPersonDeviceChanges(personId: string, options?: RequestOptions): Promise<DeviceChangesListResponse>;
|
|
16088
18019
|
/**
|
|
16089
18020
|
* Identify Person
|
|
16090
18021
|
*
|
|
@@ -17508,6 +19439,7 @@ export declare class ApiClient {
|
|
|
17508
19439
|
readonly inbound: InboundApi;
|
|
17509
19440
|
readonly installs: InstallsApi;
|
|
17510
19441
|
readonly jobs: JobsApi;
|
|
19442
|
+
readonly knownCustomers: KnownCustomersApi;
|
|
17511
19443
|
readonly leaderboards: LeaderboardsApi;
|
|
17512
19444
|
readonly links: LinksApi;
|
|
17513
19445
|
readonly migration: MigrationApi;
|