@seekora-ai/admin-api 1.1.84 → 1.1.86
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/README.md +63 -2
- package/api.ts +5235 -1581
- package/dist/api.d.ts +2629 -4
- package/dist/api.js +1900 -14
- package/dist/esm/api.d.ts +2629 -4
- package/dist/esm/api.js +1874 -4
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.86.tgz +0 -0
- package/seekora-ai-admin-api-1.1.84.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -3448,6 +3448,383 @@ export interface AnalyticsCreateFunnelRequestBody {
|
|
|
3448
3448
|
*/
|
|
3449
3449
|
'store_id'?: number;
|
|
3450
3450
|
}
|
|
3451
|
+
/**
|
|
3452
|
+
*
|
|
3453
|
+
* @export
|
|
3454
|
+
* @interface AnalyticsCustomEventFieldBreakdown
|
|
3455
|
+
*/
|
|
3456
|
+
export interface AnalyticsCustomEventFieldBreakdown {
|
|
3457
|
+
/**
|
|
3458
|
+
*
|
|
3459
|
+
* @type {string}
|
|
3460
|
+
* @memberof AnalyticsCustomEventFieldBreakdown
|
|
3461
|
+
*/
|
|
3462
|
+
'event_name'?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
*
|
|
3465
|
+
* @type {string}
|
|
3466
|
+
* @memberof AnalyticsCustomEventFieldBreakdown
|
|
3467
|
+
*/
|
|
3468
|
+
'field_name'?: string;
|
|
3469
|
+
/**
|
|
3470
|
+
*
|
|
3471
|
+
* @type {string}
|
|
3472
|
+
* @memberof AnalyticsCustomEventFieldBreakdown
|
|
3473
|
+
*/
|
|
3474
|
+
'field_slot'?: string;
|
|
3475
|
+
/**
|
|
3476
|
+
*
|
|
3477
|
+
* @type {Array<AnalyticsFieldBreakdownEntry>}
|
|
3478
|
+
* @memberof AnalyticsCustomEventFieldBreakdown
|
|
3479
|
+
*/
|
|
3480
|
+
'values'?: Array<AnalyticsFieldBreakdownEntry>;
|
|
3481
|
+
}
|
|
3482
|
+
/**
|
|
3483
|
+
*
|
|
3484
|
+
* @export
|
|
3485
|
+
* @interface AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3486
|
+
*/
|
|
3487
|
+
export interface AnalyticsCustomEventFieldBreakdownRequestBody {
|
|
3488
|
+
/**
|
|
3489
|
+
*
|
|
3490
|
+
* @type {string}
|
|
3491
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3492
|
+
*/
|
|
3493
|
+
'end_date': string;
|
|
3494
|
+
/**
|
|
3495
|
+
*
|
|
3496
|
+
* @type {string}
|
|
3497
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3498
|
+
*/
|
|
3499
|
+
'event_name': string;
|
|
3500
|
+
/**
|
|
3501
|
+
*
|
|
3502
|
+
* @type {string}
|
|
3503
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3504
|
+
*/
|
|
3505
|
+
'field_slot': string;
|
|
3506
|
+
/**
|
|
3507
|
+
* hour, day, week, month
|
|
3508
|
+
* @type {string}
|
|
3509
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3510
|
+
*/
|
|
3511
|
+
'granularity'?: string;
|
|
3512
|
+
/**
|
|
3513
|
+
*
|
|
3514
|
+
* @type {number}
|
|
3515
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3516
|
+
*/
|
|
3517
|
+
'limit'?: number;
|
|
3518
|
+
/**
|
|
3519
|
+
*
|
|
3520
|
+
* @type {number}
|
|
3521
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3522
|
+
*/
|
|
3523
|
+
'page'?: number;
|
|
3524
|
+
/**
|
|
3525
|
+
*
|
|
3526
|
+
* @type {number}
|
|
3527
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3528
|
+
*/
|
|
3529
|
+
'page_size'?: number;
|
|
3530
|
+
/**
|
|
3531
|
+
*
|
|
3532
|
+
* @type {string}
|
|
3533
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3534
|
+
*/
|
|
3535
|
+
'start_date': string;
|
|
3536
|
+
/**
|
|
3537
|
+
*
|
|
3538
|
+
* @type {string}
|
|
3539
|
+
* @memberof AnalyticsCustomEventFieldBreakdownRequestBody
|
|
3540
|
+
*/
|
|
3541
|
+
'xstoreid'?: string;
|
|
3542
|
+
}
|
|
3543
|
+
/**
|
|
3544
|
+
*
|
|
3545
|
+
* @export
|
|
3546
|
+
* @interface AnalyticsCustomEventMetrics
|
|
3547
|
+
*/
|
|
3548
|
+
export interface AnalyticsCustomEventMetrics {
|
|
3549
|
+
/**
|
|
3550
|
+
*
|
|
3551
|
+
* @type {Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>}
|
|
3552
|
+
* @memberof AnalyticsCustomEventMetrics
|
|
3553
|
+
*/
|
|
3554
|
+
'time_series'?: Array<SeekoraGoSrcServicesAnalyticsTimeSeriesPoint>;
|
|
3555
|
+
/**
|
|
3556
|
+
*
|
|
3557
|
+
* @type {number}
|
|
3558
|
+
* @memberof AnalyticsCustomEventMetrics
|
|
3559
|
+
*/
|
|
3560
|
+
'total_events'?: number;
|
|
3561
|
+
/**
|
|
3562
|
+
*
|
|
3563
|
+
* @type {number}
|
|
3564
|
+
* @memberof AnalyticsCustomEventMetrics
|
|
3565
|
+
*/
|
|
3566
|
+
'unique_event_types'?: number;
|
|
3567
|
+
/**
|
|
3568
|
+
*
|
|
3569
|
+
* @type {number}
|
|
3570
|
+
* @memberof AnalyticsCustomEventMetrics
|
|
3571
|
+
*/
|
|
3572
|
+
'unique_sessions'?: number;
|
|
3573
|
+
/**
|
|
3574
|
+
*
|
|
3575
|
+
* @type {number}
|
|
3576
|
+
* @memberof AnalyticsCustomEventMetrics
|
|
3577
|
+
*/
|
|
3578
|
+
'unique_users'?: number;
|
|
3579
|
+
}
|
|
3580
|
+
/**
|
|
3581
|
+
*
|
|
3582
|
+
* @export
|
|
3583
|
+
* @interface AnalyticsCustomEventMetricsRequestBody
|
|
3584
|
+
*/
|
|
3585
|
+
export interface AnalyticsCustomEventMetricsRequestBody {
|
|
3586
|
+
/**
|
|
3587
|
+
*
|
|
3588
|
+
* @type {string}
|
|
3589
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3590
|
+
*/
|
|
3591
|
+
'end_date': string;
|
|
3592
|
+
/**
|
|
3593
|
+
*
|
|
3594
|
+
* @type {string}
|
|
3595
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3596
|
+
*/
|
|
3597
|
+
'event_name'?: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* hour, day, week, month
|
|
3600
|
+
* @type {string}
|
|
3601
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3602
|
+
*/
|
|
3603
|
+
'granularity'?: string;
|
|
3604
|
+
/**
|
|
3605
|
+
*
|
|
3606
|
+
* @type {number}
|
|
3607
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3608
|
+
*/
|
|
3609
|
+
'page'?: number;
|
|
3610
|
+
/**
|
|
3611
|
+
*
|
|
3612
|
+
* @type {number}
|
|
3613
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3614
|
+
*/
|
|
3615
|
+
'page_size'?: number;
|
|
3616
|
+
/**
|
|
3617
|
+
*
|
|
3618
|
+
* @type {string}
|
|
3619
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3620
|
+
*/
|
|
3621
|
+
'start_date': string;
|
|
3622
|
+
/**
|
|
3623
|
+
*
|
|
3624
|
+
* @type {string}
|
|
3625
|
+
* @memberof AnalyticsCustomEventMetricsRequestBody
|
|
3626
|
+
*/
|
|
3627
|
+
'xstoreid'?: string;
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
*
|
|
3631
|
+
* @export
|
|
3632
|
+
* @interface AnalyticsCustomEventRow
|
|
3633
|
+
*/
|
|
3634
|
+
export interface AnalyticsCustomEventRow {
|
|
3635
|
+
/**
|
|
3636
|
+
*
|
|
3637
|
+
* @type {string}
|
|
3638
|
+
* @memberof AnalyticsCustomEventRow
|
|
3639
|
+
*/
|
|
3640
|
+
'event_id'?: string;
|
|
3641
|
+
/**
|
|
3642
|
+
*
|
|
3643
|
+
* @type {string}
|
|
3644
|
+
* @memberof AnalyticsCustomEventRow
|
|
3645
|
+
*/
|
|
3646
|
+
'event_name'?: string;
|
|
3647
|
+
/**
|
|
3648
|
+
*
|
|
3649
|
+
* @type {string}
|
|
3650
|
+
* @memberof AnalyticsCustomEventRow
|
|
3651
|
+
*/
|
|
3652
|
+
'event_ts'?: string;
|
|
3653
|
+
/**
|
|
3654
|
+
*
|
|
3655
|
+
* @type {{ [key: string]: any; }}
|
|
3656
|
+
* @memberof AnalyticsCustomEventRow
|
|
3657
|
+
*/
|
|
3658
|
+
'fields'?: {
|
|
3659
|
+
[key: string]: any;
|
|
3660
|
+
};
|
|
3661
|
+
/**
|
|
3662
|
+
*
|
|
3663
|
+
* @type {string}
|
|
3664
|
+
* @memberof AnalyticsCustomEventRow
|
|
3665
|
+
*/
|
|
3666
|
+
'session_id'?: string;
|
|
3667
|
+
/**
|
|
3668
|
+
*
|
|
3669
|
+
* @type {string}
|
|
3670
|
+
* @memberof AnalyticsCustomEventRow
|
|
3671
|
+
*/
|
|
3672
|
+
'user_key'?: string;
|
|
3673
|
+
}
|
|
3674
|
+
/**
|
|
3675
|
+
*
|
|
3676
|
+
* @export
|
|
3677
|
+
* @interface AnalyticsCustomEventStreamRequestBody
|
|
3678
|
+
*/
|
|
3679
|
+
export interface AnalyticsCustomEventStreamRequestBody {
|
|
3680
|
+
/**
|
|
3681
|
+
*
|
|
3682
|
+
* @type {string}
|
|
3683
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3684
|
+
*/
|
|
3685
|
+
'end_date': string;
|
|
3686
|
+
/**
|
|
3687
|
+
*
|
|
3688
|
+
* @type {string}
|
|
3689
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3690
|
+
*/
|
|
3691
|
+
'event_name'?: string;
|
|
3692
|
+
/**
|
|
3693
|
+
* hour, day, week, month
|
|
3694
|
+
* @type {string}
|
|
3695
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3696
|
+
*/
|
|
3697
|
+
'granularity'?: string;
|
|
3698
|
+
/**
|
|
3699
|
+
*
|
|
3700
|
+
* @type {number}
|
|
3701
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3702
|
+
*/
|
|
3703
|
+
'page'?: number;
|
|
3704
|
+
/**
|
|
3705
|
+
*
|
|
3706
|
+
* @type {number}
|
|
3707
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3708
|
+
*/
|
|
3709
|
+
'page_size'?: number;
|
|
3710
|
+
/**
|
|
3711
|
+
*
|
|
3712
|
+
* @type {string}
|
|
3713
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3714
|
+
*/
|
|
3715
|
+
'start_date': string;
|
|
3716
|
+
/**
|
|
3717
|
+
*
|
|
3718
|
+
* @type {string}
|
|
3719
|
+
* @memberof AnalyticsCustomEventStreamRequestBody
|
|
3720
|
+
*/
|
|
3721
|
+
'xstoreid'?: string;
|
|
3722
|
+
}
|
|
3723
|
+
/**
|
|
3724
|
+
*
|
|
3725
|
+
* @export
|
|
3726
|
+
* @interface AnalyticsCustomEventSummary
|
|
3727
|
+
*/
|
|
3728
|
+
export interface AnalyticsCustomEventSummary {
|
|
3729
|
+
/**
|
|
3730
|
+
*
|
|
3731
|
+
* @type {number}
|
|
3732
|
+
* @memberof AnalyticsCustomEventSummary
|
|
3733
|
+
*/
|
|
3734
|
+
'event_count'?: number;
|
|
3735
|
+
/**
|
|
3736
|
+
*
|
|
3737
|
+
* @type {string}
|
|
3738
|
+
* @memberof AnalyticsCustomEventSummary
|
|
3739
|
+
*/
|
|
3740
|
+
'event_name'?: string;
|
|
3741
|
+
/**
|
|
3742
|
+
*
|
|
3743
|
+
* @type {string}
|
|
3744
|
+
* @memberof AnalyticsCustomEventSummary
|
|
3745
|
+
*/
|
|
3746
|
+
'last_seen'?: string;
|
|
3747
|
+
/**
|
|
3748
|
+
*
|
|
3749
|
+
* @type {number}
|
|
3750
|
+
* @memberof AnalyticsCustomEventSummary
|
|
3751
|
+
*/
|
|
3752
|
+
'unique_users'?: number;
|
|
3753
|
+
}
|
|
3754
|
+
/**
|
|
3755
|
+
*
|
|
3756
|
+
* @export
|
|
3757
|
+
* @interface AnalyticsCustomEventTimeSeriesPoint
|
|
3758
|
+
*/
|
|
3759
|
+
export interface AnalyticsCustomEventTimeSeriesPoint {
|
|
3760
|
+
/**
|
|
3761
|
+
*
|
|
3762
|
+
* @type {number}
|
|
3763
|
+
* @memberof AnalyticsCustomEventTimeSeriesPoint
|
|
3764
|
+
*/
|
|
3765
|
+
'count'?: number;
|
|
3766
|
+
/**
|
|
3767
|
+
*
|
|
3768
|
+
* @type {string}
|
|
3769
|
+
* @memberof AnalyticsCustomEventTimeSeriesPoint
|
|
3770
|
+
*/
|
|
3771
|
+
'event_name'?: string;
|
|
3772
|
+
/**
|
|
3773
|
+
*
|
|
3774
|
+
* @type {string}
|
|
3775
|
+
* @memberof AnalyticsCustomEventTimeSeriesPoint
|
|
3776
|
+
*/
|
|
3777
|
+
'timestamp'?: string;
|
|
3778
|
+
}
|
|
3779
|
+
/**
|
|
3780
|
+
*
|
|
3781
|
+
* @export
|
|
3782
|
+
* @interface AnalyticsCustomEventTimeSeriesRequestBody
|
|
3783
|
+
*/
|
|
3784
|
+
export interface AnalyticsCustomEventTimeSeriesRequestBody {
|
|
3785
|
+
/**
|
|
3786
|
+
*
|
|
3787
|
+
* @type {string}
|
|
3788
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3789
|
+
*/
|
|
3790
|
+
'end_date': string;
|
|
3791
|
+
/**
|
|
3792
|
+
*
|
|
3793
|
+
* @type {string}
|
|
3794
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3795
|
+
*/
|
|
3796
|
+
'event_name'?: string;
|
|
3797
|
+
/**
|
|
3798
|
+
* hour, day, week, month
|
|
3799
|
+
* @type {string}
|
|
3800
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3801
|
+
*/
|
|
3802
|
+
'granularity'?: string;
|
|
3803
|
+
/**
|
|
3804
|
+
*
|
|
3805
|
+
* @type {number}
|
|
3806
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3807
|
+
*/
|
|
3808
|
+
'page'?: number;
|
|
3809
|
+
/**
|
|
3810
|
+
*
|
|
3811
|
+
* @type {number}
|
|
3812
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3813
|
+
*/
|
|
3814
|
+
'page_size'?: number;
|
|
3815
|
+
/**
|
|
3816
|
+
*
|
|
3817
|
+
* @type {string}
|
|
3818
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3819
|
+
*/
|
|
3820
|
+
'start_date': string;
|
|
3821
|
+
/**
|
|
3822
|
+
*
|
|
3823
|
+
* @type {string}
|
|
3824
|
+
* @memberof AnalyticsCustomEventTimeSeriesRequestBody
|
|
3825
|
+
*/
|
|
3826
|
+
'xstoreid'?: string;
|
|
3827
|
+
}
|
|
3451
3828
|
/**
|
|
3452
3829
|
*
|
|
3453
3830
|
* @export
|
|
@@ -3752,6 +4129,25 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
3752
4129
|
*/
|
|
3753
4130
|
'xstoreid'?: string;
|
|
3754
4131
|
}
|
|
4132
|
+
/**
|
|
4133
|
+
*
|
|
4134
|
+
* @export
|
|
4135
|
+
* @interface AnalyticsFieldBreakdownEntry
|
|
4136
|
+
*/
|
|
4137
|
+
export interface AnalyticsFieldBreakdownEntry {
|
|
4138
|
+
/**
|
|
4139
|
+
*
|
|
4140
|
+
* @type {number}
|
|
4141
|
+
* @memberof AnalyticsFieldBreakdownEntry
|
|
4142
|
+
*/
|
|
4143
|
+
'count'?: number;
|
|
4144
|
+
/**
|
|
4145
|
+
*
|
|
4146
|
+
* @type {string}
|
|
4147
|
+
* @memberof AnalyticsFieldBreakdownEntry
|
|
4148
|
+
*/
|
|
4149
|
+
'value'?: string;
|
|
4150
|
+
}
|
|
3755
4151
|
/**
|
|
3756
4152
|
*
|
|
3757
4153
|
* @export
|
|
@@ -6831,6 +7227,12 @@ export interface AnalyticsKPIMetrics {
|
|
|
6831
7227
|
* @memberof AnalyticsKPIMetrics
|
|
6832
7228
|
*/
|
|
6833
7229
|
'revenue_currency'?: string;
|
|
7230
|
+
/**
|
|
7231
|
+
*
|
|
7232
|
+
* @type {number}
|
|
7233
|
+
* @memberof AnalyticsKPIMetrics
|
|
7234
|
+
*/
|
|
7235
|
+
'total_custom_events'?: number;
|
|
6834
7236
|
/**
|
|
6835
7237
|
*
|
|
6836
7238
|
* @type {number}
|
|
@@ -6886,6 +7288,12 @@ export interface AnalyticsKPIPointExtended {
|
|
|
6886
7288
|
* @memberof AnalyticsKPIPointExtended
|
|
6887
7289
|
*/
|
|
6888
7290
|
'ctr'?: number;
|
|
7291
|
+
/**
|
|
7292
|
+
*
|
|
7293
|
+
* @type {number}
|
|
7294
|
+
* @memberof AnalyticsKPIPointExtended
|
|
7295
|
+
*/
|
|
7296
|
+
'custom_events'?: number;
|
|
6889
7297
|
/**
|
|
6890
7298
|
*
|
|
6891
7299
|
* @type {number}
|
|
@@ -7134,6 +7542,43 @@ export interface AnalyticsOverviewComparison {
|
|
|
7134
7542
|
*/
|
|
7135
7543
|
'revenue'?: AnalyticsPeriodComparison;
|
|
7136
7544
|
}
|
|
7545
|
+
/**
|
|
7546
|
+
*
|
|
7547
|
+
* @export
|
|
7548
|
+
* @interface AnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
7549
|
+
*/
|
|
7550
|
+
export interface AnalyticsPaginatedResponseAnalyticsCustomEventRow {
|
|
7551
|
+
/**
|
|
7552
|
+
*
|
|
7553
|
+
* @type {Array<AnalyticsCustomEventRow>}
|
|
7554
|
+
* @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
7555
|
+
*/
|
|
7556
|
+
'data'?: Array<AnalyticsCustomEventRow>;
|
|
7557
|
+
/**
|
|
7558
|
+
*
|
|
7559
|
+
* @type {number}
|
|
7560
|
+
* @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
7561
|
+
*/
|
|
7562
|
+
'page'?: number;
|
|
7563
|
+
/**
|
|
7564
|
+
*
|
|
7565
|
+
* @type {number}
|
|
7566
|
+
* @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
7567
|
+
*/
|
|
7568
|
+
'page_size'?: number;
|
|
7569
|
+
/**
|
|
7570
|
+
*
|
|
7571
|
+
* @type {number}
|
|
7572
|
+
* @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
7573
|
+
*/
|
|
7574
|
+
'total'?: number;
|
|
7575
|
+
/**
|
|
7576
|
+
*
|
|
7577
|
+
* @type {number}
|
|
7578
|
+
* @memberof AnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
7579
|
+
*/
|
|
7580
|
+
'total_pages'?: number;
|
|
7581
|
+
}
|
|
7137
7582
|
/**
|
|
7138
7583
|
*
|
|
7139
7584
|
* @export
|
|
@@ -10670,6 +11115,61 @@ export interface AnalyticsTimeWindow {
|
|
|
10670
11115
|
*/
|
|
10671
11116
|
'start_date'?: string;
|
|
10672
11117
|
}
|
|
11118
|
+
/**
|
|
11119
|
+
*
|
|
11120
|
+
* @export
|
|
11121
|
+
* @interface AnalyticsTopCustomEventsRequestBody
|
|
11122
|
+
*/
|
|
11123
|
+
export interface AnalyticsTopCustomEventsRequestBody {
|
|
11124
|
+
/**
|
|
11125
|
+
*
|
|
11126
|
+
* @type {string}
|
|
11127
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11128
|
+
*/
|
|
11129
|
+
'end_date': string;
|
|
11130
|
+
/**
|
|
11131
|
+
* hour, day, week, month
|
|
11132
|
+
* @type {string}
|
|
11133
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11134
|
+
*/
|
|
11135
|
+
'granularity'?: string;
|
|
11136
|
+
/**
|
|
11137
|
+
*
|
|
11138
|
+
* @type {number}
|
|
11139
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11140
|
+
*/
|
|
11141
|
+
'limit'?: number;
|
|
11142
|
+
/**
|
|
11143
|
+
*
|
|
11144
|
+
* @type {number}
|
|
11145
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11146
|
+
*/
|
|
11147
|
+
'page'?: number;
|
|
11148
|
+
/**
|
|
11149
|
+
*
|
|
11150
|
+
* @type {number}
|
|
11151
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11152
|
+
*/
|
|
11153
|
+
'page_size'?: number;
|
|
11154
|
+
/**
|
|
11155
|
+
*
|
|
11156
|
+
* @type {string}
|
|
11157
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11158
|
+
*/
|
|
11159
|
+
'sort_by'?: string;
|
|
11160
|
+
/**
|
|
11161
|
+
*
|
|
11162
|
+
* @type {string}
|
|
11163
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11164
|
+
*/
|
|
11165
|
+
'start_date': string;
|
|
11166
|
+
/**
|
|
11167
|
+
*
|
|
11168
|
+
* @type {string}
|
|
11169
|
+
* @memberof AnalyticsTopCustomEventsRequestBody
|
|
11170
|
+
*/
|
|
11171
|
+
'xstoreid'?: string;
|
|
11172
|
+
}
|
|
10673
11173
|
/**
|
|
10674
11174
|
*
|
|
10675
11175
|
* @export
|
|
@@ -13667,6 +14167,97 @@ export declare const DataTypesCreateCustomWordListRequestTypeEnum: {
|
|
|
13667
14167
|
readonly Synonyms: "synonyms";
|
|
13668
14168
|
};
|
|
13669
14169
|
export type DataTypesCreateCustomWordListRequestTypeEnum = typeof DataTypesCreateCustomWordListRequestTypeEnum[keyof typeof DataTypesCreateCustomWordListRequestTypeEnum];
|
|
14170
|
+
/**
|
|
14171
|
+
*
|
|
14172
|
+
* @export
|
|
14173
|
+
* @interface DataTypesCreateExperimentRequest
|
|
14174
|
+
*/
|
|
14175
|
+
export interface DataTypesCreateExperimentRequest {
|
|
14176
|
+
/**
|
|
14177
|
+
*
|
|
14178
|
+
* @type {object}
|
|
14179
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14180
|
+
*/
|
|
14181
|
+
'audience_filter'?: object;
|
|
14182
|
+
/**
|
|
14183
|
+
*
|
|
14184
|
+
* @type {string}
|
|
14185
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14186
|
+
*/
|
|
14187
|
+
'description'?: string;
|
|
14188
|
+
/**
|
|
14189
|
+
*
|
|
14190
|
+
* @type {string}
|
|
14191
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14192
|
+
*/
|
|
14193
|
+
'experiment_id': string;
|
|
14194
|
+
/**
|
|
14195
|
+
*
|
|
14196
|
+
* @type {DataTypesExperimentType}
|
|
14197
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14198
|
+
*/
|
|
14199
|
+
'experiment_type': DataTypesExperimentType;
|
|
14200
|
+
/**
|
|
14201
|
+
*
|
|
14202
|
+
* @type {string}
|
|
14203
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14204
|
+
*/
|
|
14205
|
+
'hypothesis'?: string;
|
|
14206
|
+
/**
|
|
14207
|
+
*
|
|
14208
|
+
* @type {number}
|
|
14209
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14210
|
+
*/
|
|
14211
|
+
'max_duration_days'?: number;
|
|
14212
|
+
/**
|
|
14213
|
+
*
|
|
14214
|
+
* @type {number}
|
|
14215
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14216
|
+
*/
|
|
14217
|
+
'min_sample_size'?: number;
|
|
14218
|
+
/**
|
|
14219
|
+
*
|
|
14220
|
+
* @type {string}
|
|
14221
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14222
|
+
*/
|
|
14223
|
+
'name': string;
|
|
14224
|
+
/**
|
|
14225
|
+
*
|
|
14226
|
+
* @type {string}
|
|
14227
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14228
|
+
*/
|
|
14229
|
+
'primary_metric': string;
|
|
14230
|
+
/**
|
|
14231
|
+
*
|
|
14232
|
+
* @type {string}
|
|
14233
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14234
|
+
*/
|
|
14235
|
+
'scheduled_end_at'?: string;
|
|
14236
|
+
/**
|
|
14237
|
+
*
|
|
14238
|
+
* @type {string}
|
|
14239
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14240
|
+
*/
|
|
14241
|
+
'scheduled_start_at'?: string;
|
|
14242
|
+
/**
|
|
14243
|
+
*
|
|
14244
|
+
* @type {Array<string>}
|
|
14245
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14246
|
+
*/
|
|
14247
|
+
'secondary_metrics'?: Array<string>;
|
|
14248
|
+
/**
|
|
14249
|
+
*
|
|
14250
|
+
* @type {number}
|
|
14251
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14252
|
+
*/
|
|
14253
|
+
'traffic_percentage'?: number;
|
|
14254
|
+
/**
|
|
14255
|
+
*
|
|
14256
|
+
* @type {Array<DataTypesExperimentVariant>}
|
|
14257
|
+
* @memberof DataTypesCreateExperimentRequest
|
|
14258
|
+
*/
|
|
14259
|
+
'variants': Array<DataTypesExperimentVariant>;
|
|
14260
|
+
}
|
|
13670
14261
|
/**
|
|
13671
14262
|
*
|
|
13672
14263
|
* @export
|
|
@@ -16887,6 +17478,440 @@ export interface DataTypesEventPayload {
|
|
|
16887
17478
|
*/
|
|
16888
17479
|
'xstoreid'?: string;
|
|
16889
17480
|
}
|
|
17481
|
+
/**
|
|
17482
|
+
*
|
|
17483
|
+
* @export
|
|
17484
|
+
* @interface DataTypesExperiment
|
|
17485
|
+
*/
|
|
17486
|
+
export interface DataTypesExperiment {
|
|
17487
|
+
/**
|
|
17488
|
+
*
|
|
17489
|
+
* @type {object}
|
|
17490
|
+
* @memberof DataTypesExperiment
|
|
17491
|
+
*/
|
|
17492
|
+
'audience_filter'?: object;
|
|
17493
|
+
/**
|
|
17494
|
+
*
|
|
17495
|
+
* @type {number}
|
|
17496
|
+
* @memberof DataTypesExperiment
|
|
17497
|
+
*/
|
|
17498
|
+
'confidence_level'?: number;
|
|
17499
|
+
/**
|
|
17500
|
+
*
|
|
17501
|
+
* @type {string}
|
|
17502
|
+
* @memberof DataTypesExperiment
|
|
17503
|
+
*/
|
|
17504
|
+
'created_at'?: string;
|
|
17505
|
+
/**
|
|
17506
|
+
*
|
|
17507
|
+
* @type {number}
|
|
17508
|
+
* @memberof DataTypesExperiment
|
|
17509
|
+
*/
|
|
17510
|
+
'created_by'?: number;
|
|
17511
|
+
/**
|
|
17512
|
+
*
|
|
17513
|
+
* @type {string}
|
|
17514
|
+
* @memberof DataTypesExperiment
|
|
17515
|
+
*/
|
|
17516
|
+
'description'?: string;
|
|
17517
|
+
/**
|
|
17518
|
+
*
|
|
17519
|
+
* @type {string}
|
|
17520
|
+
* @memberof DataTypesExperiment
|
|
17521
|
+
*/
|
|
17522
|
+
'ended_at'?: string;
|
|
17523
|
+
/**
|
|
17524
|
+
*
|
|
17525
|
+
* @type {string}
|
|
17526
|
+
* @memberof DataTypesExperiment
|
|
17527
|
+
*/
|
|
17528
|
+
'experiment_id'?: string;
|
|
17529
|
+
/**
|
|
17530
|
+
*
|
|
17531
|
+
* @type {DataTypesExperimentType}
|
|
17532
|
+
* @memberof DataTypesExperiment
|
|
17533
|
+
*/
|
|
17534
|
+
'experiment_type'?: DataTypesExperimentType;
|
|
17535
|
+
/**
|
|
17536
|
+
*
|
|
17537
|
+
* @type {object}
|
|
17538
|
+
* @memberof DataTypesExperiment
|
|
17539
|
+
*/
|
|
17540
|
+
'final_results'?: object;
|
|
17541
|
+
/**
|
|
17542
|
+
*
|
|
17543
|
+
* @type {string}
|
|
17544
|
+
* @memberof DataTypesExperiment
|
|
17545
|
+
*/
|
|
17546
|
+
'hypothesis'?: string;
|
|
17547
|
+
/**
|
|
17548
|
+
*
|
|
17549
|
+
* @type {number}
|
|
17550
|
+
* @memberof DataTypesExperiment
|
|
17551
|
+
*/
|
|
17552
|
+
'id'?: number;
|
|
17553
|
+
/**
|
|
17554
|
+
*
|
|
17555
|
+
* @type {number}
|
|
17556
|
+
* @memberof DataTypesExperiment
|
|
17557
|
+
*/
|
|
17558
|
+
'max_duration_days'?: number;
|
|
17559
|
+
/**
|
|
17560
|
+
*
|
|
17561
|
+
* @type {number}
|
|
17562
|
+
* @memberof DataTypesExperiment
|
|
17563
|
+
*/
|
|
17564
|
+
'min_sample_size'?: number;
|
|
17565
|
+
/**
|
|
17566
|
+
*
|
|
17567
|
+
* @type {string}
|
|
17568
|
+
* @memberof DataTypesExperiment
|
|
17569
|
+
*/
|
|
17570
|
+
'name'?: string;
|
|
17571
|
+
/**
|
|
17572
|
+
*
|
|
17573
|
+
* @type {number}
|
|
17574
|
+
* @memberof DataTypesExperiment
|
|
17575
|
+
*/
|
|
17576
|
+
'org_id'?: number;
|
|
17577
|
+
/**
|
|
17578
|
+
*
|
|
17579
|
+
* @type {string}
|
|
17580
|
+
* @memberof DataTypesExperiment
|
|
17581
|
+
*/
|
|
17582
|
+
'primary_metric'?: string;
|
|
17583
|
+
/**
|
|
17584
|
+
*
|
|
17585
|
+
* @type {string}
|
|
17586
|
+
* @memberof DataTypesExperiment
|
|
17587
|
+
*/
|
|
17588
|
+
'scheduled_end_at'?: string;
|
|
17589
|
+
/**
|
|
17590
|
+
*
|
|
17591
|
+
* @type {string}
|
|
17592
|
+
* @memberof DataTypesExperiment
|
|
17593
|
+
*/
|
|
17594
|
+
'scheduled_start_at'?: string;
|
|
17595
|
+
/**
|
|
17596
|
+
*
|
|
17597
|
+
* @type {Array<string>}
|
|
17598
|
+
* @memberof DataTypesExperiment
|
|
17599
|
+
*/
|
|
17600
|
+
'secondary_metrics'?: Array<string>;
|
|
17601
|
+
/**
|
|
17602
|
+
*
|
|
17603
|
+
* @type {string}
|
|
17604
|
+
* @memberof DataTypesExperiment
|
|
17605
|
+
*/
|
|
17606
|
+
'started_at'?: string;
|
|
17607
|
+
/**
|
|
17608
|
+
*
|
|
17609
|
+
* @type {number}
|
|
17610
|
+
* @memberof DataTypesExperiment
|
|
17611
|
+
*/
|
|
17612
|
+
'statistical_significance'?: number;
|
|
17613
|
+
/**
|
|
17614
|
+
*
|
|
17615
|
+
* @type {DataTypesExperimentStatus}
|
|
17616
|
+
* @memberof DataTypesExperiment
|
|
17617
|
+
*/
|
|
17618
|
+
'status'?: DataTypesExperimentStatus;
|
|
17619
|
+
/**
|
|
17620
|
+
*
|
|
17621
|
+
* @type {number}
|
|
17622
|
+
* @memberof DataTypesExperiment
|
|
17623
|
+
*/
|
|
17624
|
+
'store_id'?: number;
|
|
17625
|
+
/**
|
|
17626
|
+
*
|
|
17627
|
+
* @type {number}
|
|
17628
|
+
* @memberof DataTypesExperiment
|
|
17629
|
+
*/
|
|
17630
|
+
'traffic_percentage'?: number;
|
|
17631
|
+
/**
|
|
17632
|
+
*
|
|
17633
|
+
* @type {string}
|
|
17634
|
+
* @memberof DataTypesExperiment
|
|
17635
|
+
*/
|
|
17636
|
+
'updated_at'?: string;
|
|
17637
|
+
/**
|
|
17638
|
+
*
|
|
17639
|
+
* @type {number}
|
|
17640
|
+
* @memberof DataTypesExperiment
|
|
17641
|
+
*/
|
|
17642
|
+
'updated_by'?: number;
|
|
17643
|
+
/**
|
|
17644
|
+
*
|
|
17645
|
+
* @type {Array<DataTypesExperimentVariant>}
|
|
17646
|
+
* @memberof DataTypesExperiment
|
|
17647
|
+
*/
|
|
17648
|
+
'variants'?: Array<DataTypesExperimentVariant>;
|
|
17649
|
+
/**
|
|
17650
|
+
*
|
|
17651
|
+
* @type {string}
|
|
17652
|
+
* @memberof DataTypesExperiment
|
|
17653
|
+
*/
|
|
17654
|
+
'winner_variant'?: string;
|
|
17655
|
+
}
|
|
17656
|
+
/**
|
|
17657
|
+
*
|
|
17658
|
+
* @export
|
|
17659
|
+
* @interface DataTypesExperimentAssignment
|
|
17660
|
+
*/
|
|
17661
|
+
export interface DataTypesExperimentAssignment {
|
|
17662
|
+
/**
|
|
17663
|
+
*
|
|
17664
|
+
* @type {string}
|
|
17665
|
+
* @memberof DataTypesExperimentAssignment
|
|
17666
|
+
*/
|
|
17667
|
+
'experiment_id'?: string;
|
|
17668
|
+
/**
|
|
17669
|
+
*
|
|
17670
|
+
* @type {{ [key: string]: any; }}
|
|
17671
|
+
* @memberof DataTypesExperimentAssignment
|
|
17672
|
+
*/
|
|
17673
|
+
'variant_config'?: {
|
|
17674
|
+
[key: string]: any;
|
|
17675
|
+
};
|
|
17676
|
+
/**
|
|
17677
|
+
*
|
|
17678
|
+
* @type {string}
|
|
17679
|
+
* @memberof DataTypesExperimentAssignment
|
|
17680
|
+
*/
|
|
17681
|
+
'variant_id'?: string;
|
|
17682
|
+
}
|
|
17683
|
+
/**
|
|
17684
|
+
*
|
|
17685
|
+
* @export
|
|
17686
|
+
* @interface DataTypesExperimentAssignmentResponse
|
|
17687
|
+
*/
|
|
17688
|
+
export interface DataTypesExperimentAssignmentResponse {
|
|
17689
|
+
/**
|
|
17690
|
+
*
|
|
17691
|
+
* @type {Array<DataTypesExperimentAssignment>}
|
|
17692
|
+
* @memberof DataTypesExperimentAssignmentResponse
|
|
17693
|
+
*/
|
|
17694
|
+
'assignments'?: Array<DataTypesExperimentAssignment>;
|
|
17695
|
+
}
|
|
17696
|
+
/**
|
|
17697
|
+
*
|
|
17698
|
+
* @export
|
|
17699
|
+
* @interface DataTypesExperimentResults
|
|
17700
|
+
*/
|
|
17701
|
+
export interface DataTypesExperimentResults {
|
|
17702
|
+
/**
|
|
17703
|
+
*
|
|
17704
|
+
* @type {number}
|
|
17705
|
+
* @memberof DataTypesExperimentResults
|
|
17706
|
+
*/
|
|
17707
|
+
'confidence_level'?: number;
|
|
17708
|
+
/**
|
|
17709
|
+
*
|
|
17710
|
+
* @type {number}
|
|
17711
|
+
* @memberof DataTypesExperimentResults
|
|
17712
|
+
*/
|
|
17713
|
+
'conversion_lift'?: number;
|
|
17714
|
+
/**
|
|
17715
|
+
*
|
|
17716
|
+
* @type {number}
|
|
17717
|
+
* @memberof DataTypesExperimentResults
|
|
17718
|
+
*/
|
|
17719
|
+
'ctr_lift'?: number;
|
|
17720
|
+
/**
|
|
17721
|
+
*
|
|
17722
|
+
* @type {string}
|
|
17723
|
+
* @memberof DataTypesExperimentResults
|
|
17724
|
+
*/
|
|
17725
|
+
'ended_at'?: string;
|
|
17726
|
+
/**
|
|
17727
|
+
*
|
|
17728
|
+
* @type {string}
|
|
17729
|
+
* @memberof DataTypesExperimentResults
|
|
17730
|
+
*/
|
|
17731
|
+
'experiment_id'?: string;
|
|
17732
|
+
/**
|
|
17733
|
+
*
|
|
17734
|
+
* @type {boolean}
|
|
17735
|
+
* @memberof DataTypesExperimentResults
|
|
17736
|
+
*/
|
|
17737
|
+
'is_significant'?: boolean;
|
|
17738
|
+
/**
|
|
17739
|
+
*
|
|
17740
|
+
* @type {string}
|
|
17741
|
+
* @memberof DataTypesExperimentResults
|
|
17742
|
+
*/
|
|
17743
|
+
'name'?: string;
|
|
17744
|
+
/**
|
|
17745
|
+
*
|
|
17746
|
+
* @type {number}
|
|
17747
|
+
* @memberof DataTypesExperimentResults
|
|
17748
|
+
*/
|
|
17749
|
+
'revenue_lift'?: number;
|
|
17750
|
+
/**
|
|
17751
|
+
*
|
|
17752
|
+
* @type {string}
|
|
17753
|
+
* @memberof DataTypesExperimentResults
|
|
17754
|
+
*/
|
|
17755
|
+
'started_at'?: string;
|
|
17756
|
+
/**
|
|
17757
|
+
*
|
|
17758
|
+
* @type {DataTypesExperimentStatus}
|
|
17759
|
+
* @memberof DataTypesExperimentResults
|
|
17760
|
+
*/
|
|
17761
|
+
'status'?: DataTypesExperimentStatus;
|
|
17762
|
+
/**
|
|
17763
|
+
*
|
|
17764
|
+
* @type {Array<DataTypesExperimentVariantResult>}
|
|
17765
|
+
* @memberof DataTypesExperimentResults
|
|
17766
|
+
*/
|
|
17767
|
+
'variants'?: Array<DataTypesExperimentVariantResult>;
|
|
17768
|
+
/**
|
|
17769
|
+
*
|
|
17770
|
+
* @type {string}
|
|
17771
|
+
* @memberof DataTypesExperimentResults
|
|
17772
|
+
*/
|
|
17773
|
+
'winner'?: string;
|
|
17774
|
+
}
|
|
17775
|
+
/**
|
|
17776
|
+
*
|
|
17777
|
+
* @export
|
|
17778
|
+
* @enum {string}
|
|
17779
|
+
*/
|
|
17780
|
+
export declare const DataTypesExperimentStatus: {
|
|
17781
|
+
readonly ExperimentStatusDraft: "draft";
|
|
17782
|
+
readonly ExperimentStatusScheduled: "scheduled";
|
|
17783
|
+
readonly ExperimentStatusRunning: "running";
|
|
17784
|
+
readonly ExperimentStatusPaused: "paused";
|
|
17785
|
+
readonly ExperimentStatusCompleted: "completed";
|
|
17786
|
+
readonly ExperimentStatusArchived: "archived";
|
|
17787
|
+
};
|
|
17788
|
+
export type DataTypesExperimentStatus = typeof DataTypesExperimentStatus[keyof typeof DataTypesExperimentStatus];
|
|
17789
|
+
/**
|
|
17790
|
+
*
|
|
17791
|
+
* @export
|
|
17792
|
+
* @enum {string}
|
|
17793
|
+
*/
|
|
17794
|
+
export declare const DataTypesExperimentType: {
|
|
17795
|
+
readonly ExperimentTypeSearchRanking: "search_ranking";
|
|
17796
|
+
readonly ExperimentTypeRecommendation: "recommendation";
|
|
17797
|
+
readonly ExperimentTypePersonalization: "personalization";
|
|
17798
|
+
readonly ExperimentTypeUI: "ui";
|
|
17799
|
+
readonly ExperimentTypePricing: "pricing";
|
|
17800
|
+
readonly ExperimentTypeOther: "other";
|
|
17801
|
+
};
|
|
17802
|
+
export type DataTypesExperimentType = typeof DataTypesExperimentType[keyof typeof DataTypesExperimentType];
|
|
17803
|
+
/**
|
|
17804
|
+
*
|
|
17805
|
+
* @export
|
|
17806
|
+
* @interface DataTypesExperimentVariant
|
|
17807
|
+
*/
|
|
17808
|
+
export interface DataTypesExperimentVariant {
|
|
17809
|
+
/**
|
|
17810
|
+
*
|
|
17811
|
+
* @type {{ [key: string]: any; }}
|
|
17812
|
+
* @memberof DataTypesExperimentVariant
|
|
17813
|
+
*/
|
|
17814
|
+
'config'?: {
|
|
17815
|
+
[key: string]: any;
|
|
17816
|
+
};
|
|
17817
|
+
/**
|
|
17818
|
+
*
|
|
17819
|
+
* @type {string}
|
|
17820
|
+
* @memberof DataTypesExperimentVariant
|
|
17821
|
+
*/
|
|
17822
|
+
'id'?: string;
|
|
17823
|
+
/**
|
|
17824
|
+
*
|
|
17825
|
+
* @type {string}
|
|
17826
|
+
* @memberof DataTypesExperimentVariant
|
|
17827
|
+
*/
|
|
17828
|
+
'name'?: string;
|
|
17829
|
+
/**
|
|
17830
|
+
* Traffic weight percentage (e.g., 50 = 50%)
|
|
17831
|
+
* @type {number}
|
|
17832
|
+
* @memberof DataTypesExperimentVariant
|
|
17833
|
+
*/
|
|
17834
|
+
'weight'?: number;
|
|
17835
|
+
}
|
|
17836
|
+
/**
|
|
17837
|
+
*
|
|
17838
|
+
* @export
|
|
17839
|
+
* @interface DataTypesExperimentVariantResult
|
|
17840
|
+
*/
|
|
17841
|
+
export interface DataTypesExperimentVariantResult {
|
|
17842
|
+
/**
|
|
17843
|
+
*
|
|
17844
|
+
* @type {number}
|
|
17845
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17846
|
+
*/
|
|
17847
|
+
'avg_latency_ms'?: number;
|
|
17848
|
+
/**
|
|
17849
|
+
*
|
|
17850
|
+
* @type {number}
|
|
17851
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17852
|
+
*/
|
|
17853
|
+
'conversion_rate'?: number;
|
|
17854
|
+
/**
|
|
17855
|
+
*
|
|
17856
|
+
* @type {number}
|
|
17857
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17858
|
+
*/
|
|
17859
|
+
'conversions'?: number;
|
|
17860
|
+
/**
|
|
17861
|
+
*
|
|
17862
|
+
* @type {number}
|
|
17863
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17864
|
+
*/
|
|
17865
|
+
'ctr'?: number;
|
|
17866
|
+
/**
|
|
17867
|
+
*
|
|
17868
|
+
* @type {number}
|
|
17869
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17870
|
+
*/
|
|
17871
|
+
'revenue'?: number;
|
|
17872
|
+
/**
|
|
17873
|
+
*
|
|
17874
|
+
* @type {number}
|
|
17875
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17876
|
+
*/
|
|
17877
|
+
'revenue_per_user'?: number;
|
|
17878
|
+
/**
|
|
17879
|
+
*
|
|
17880
|
+
* @type {number}
|
|
17881
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17882
|
+
*/
|
|
17883
|
+
'total_clicks'?: number;
|
|
17884
|
+
/**
|
|
17885
|
+
*
|
|
17886
|
+
* @type {number}
|
|
17887
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17888
|
+
*/
|
|
17889
|
+
'total_searches'?: number;
|
|
17890
|
+
/**
|
|
17891
|
+
*
|
|
17892
|
+
* @type {number}
|
|
17893
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17894
|
+
*/
|
|
17895
|
+
'unique_users'?: number;
|
|
17896
|
+
/**
|
|
17897
|
+
*
|
|
17898
|
+
* @type {string}
|
|
17899
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17900
|
+
*/
|
|
17901
|
+
'variant_id'?: string;
|
|
17902
|
+
/**
|
|
17903
|
+
*
|
|
17904
|
+
* @type {string}
|
|
17905
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17906
|
+
*/
|
|
17907
|
+
'variant_name'?: string;
|
|
17908
|
+
/**
|
|
17909
|
+
*
|
|
17910
|
+
* @type {number}
|
|
17911
|
+
* @memberof DataTypesExperimentVariantResult
|
|
17912
|
+
*/
|
|
17913
|
+
'zero_result_rate'?: number;
|
|
17914
|
+
}
|
|
16890
17915
|
/**
|
|
16891
17916
|
*
|
|
16892
17917
|
* @export
|
|
@@ -16931,6 +17956,81 @@ export interface DataTypesFacetRangeConfig {
|
|
|
16931
17956
|
*/
|
|
16932
17957
|
'ranges'?: Array<DataTypesFacetRange>;
|
|
16933
17958
|
}
|
|
17959
|
+
/**
|
|
17960
|
+
*
|
|
17961
|
+
* @export
|
|
17962
|
+
* @interface DataTypesFacetValuesSearchRequest
|
|
17963
|
+
*/
|
|
17964
|
+
export interface DataTypesFacetValuesSearchRequest {
|
|
17965
|
+
/**
|
|
17966
|
+
*
|
|
17967
|
+
* @type {string}
|
|
17968
|
+
* @memberof DataTypesFacetValuesSearchRequest
|
|
17969
|
+
*/
|
|
17970
|
+
'facet_query': string;
|
|
17971
|
+
/**
|
|
17972
|
+
*
|
|
17973
|
+
* @type {string}
|
|
17974
|
+
* @memberof DataTypesFacetValuesSearchRequest
|
|
17975
|
+
*/
|
|
17976
|
+
'filter'?: string;
|
|
17977
|
+
/**
|
|
17978
|
+
*
|
|
17979
|
+
* @type {number}
|
|
17980
|
+
* @memberof DataTypesFacetValuesSearchRequest
|
|
17981
|
+
*/
|
|
17982
|
+
'max_values'?: number;
|
|
17983
|
+
/**
|
|
17984
|
+
*
|
|
17985
|
+
* @type {string}
|
|
17986
|
+
* @memberof DataTypesFacetValuesSearchRequest
|
|
17987
|
+
*/
|
|
17988
|
+
'q'?: string;
|
|
17989
|
+
}
|
|
17990
|
+
/**
|
|
17991
|
+
*
|
|
17992
|
+
* @export
|
|
17993
|
+
* @interface DataTypesFacetValuesSearchResponse
|
|
17994
|
+
*/
|
|
17995
|
+
export interface DataTypesFacetValuesSearchResponse {
|
|
17996
|
+
/**
|
|
17997
|
+
*
|
|
17998
|
+
* @type {string}
|
|
17999
|
+
* @memberof DataTypesFacetValuesSearchResponse
|
|
18000
|
+
*/
|
|
18001
|
+
'facet_name'?: string;
|
|
18002
|
+
/**
|
|
18003
|
+
*
|
|
18004
|
+
* @type {Array<DataTypesFilterValue>}
|
|
18005
|
+
* @memberof DataTypesFacetValuesSearchResponse
|
|
18006
|
+
*/
|
|
18007
|
+
'values'?: Array<DataTypesFilterValue>;
|
|
18008
|
+
}
|
|
18009
|
+
/**
|
|
18010
|
+
*
|
|
18011
|
+
* @export
|
|
18012
|
+
* @interface DataTypesFacetValuesSearchResponseWrapper
|
|
18013
|
+
*/
|
|
18014
|
+
export interface DataTypesFacetValuesSearchResponseWrapper {
|
|
18015
|
+
/**
|
|
18016
|
+
*
|
|
18017
|
+
* @type {DataTypesFacetValuesSearchResponse}
|
|
18018
|
+
* @memberof DataTypesFacetValuesSearchResponseWrapper
|
|
18019
|
+
*/
|
|
18020
|
+
'data'?: DataTypesFacetValuesSearchResponse;
|
|
18021
|
+
/**
|
|
18022
|
+
*
|
|
18023
|
+
* @type {string}
|
|
18024
|
+
* @memberof DataTypesFacetValuesSearchResponseWrapper
|
|
18025
|
+
*/
|
|
18026
|
+
'message'?: string;
|
|
18027
|
+
/**
|
|
18028
|
+
*
|
|
18029
|
+
* @type {number}
|
|
18030
|
+
* @memberof DataTypesFacetValuesSearchResponseWrapper
|
|
18031
|
+
*/
|
|
18032
|
+
'status'?: number;
|
|
18033
|
+
}
|
|
16934
18034
|
/**
|
|
16935
18035
|
*
|
|
16936
18036
|
* @export
|
|
@@ -17325,6 +18425,142 @@ export interface DataTypesFieldMetadata {
|
|
|
17325
18425
|
*/
|
|
17326
18426
|
'type'?: string;
|
|
17327
18427
|
}
|
|
18428
|
+
/**
|
|
18429
|
+
*
|
|
18430
|
+
* @export
|
|
18431
|
+
* @interface DataTypesFilterField
|
|
18432
|
+
*/
|
|
18433
|
+
export interface DataTypesFilterField {
|
|
18434
|
+
/**
|
|
18435
|
+
*
|
|
18436
|
+
* @type {string}
|
|
18437
|
+
* @memberof DataTypesFilterField
|
|
18438
|
+
*/
|
|
18439
|
+
'field'?: string;
|
|
18440
|
+
/**
|
|
18441
|
+
*
|
|
18442
|
+
* @type {DataTypesFilterStats}
|
|
18443
|
+
* @memberof DataTypesFilterField
|
|
18444
|
+
*/
|
|
18445
|
+
'stats'?: DataTypesFilterStats;
|
|
18446
|
+
/**
|
|
18447
|
+
*
|
|
18448
|
+
* @type {number}
|
|
18449
|
+
* @memberof DataTypesFilterField
|
|
18450
|
+
*/
|
|
18451
|
+
'total_values'?: number;
|
|
18452
|
+
/**
|
|
18453
|
+
* \"categorical\", \"numeric\", \"boolean\"
|
|
18454
|
+
* @type {string}
|
|
18455
|
+
* @memberof DataTypesFilterField
|
|
18456
|
+
*/
|
|
18457
|
+
'type'?: string;
|
|
18458
|
+
/**
|
|
18459
|
+
*
|
|
18460
|
+
* @type {Array<DataTypesFilterValue>}
|
|
18461
|
+
* @memberof DataTypesFilterField
|
|
18462
|
+
*/
|
|
18463
|
+
'values'?: Array<DataTypesFilterValue>;
|
|
18464
|
+
}
|
|
18465
|
+
/**
|
|
18466
|
+
*
|
|
18467
|
+
* @export
|
|
18468
|
+
* @interface DataTypesFilterSchemaField
|
|
18469
|
+
*/
|
|
18470
|
+
export interface DataTypesFilterSchemaField {
|
|
18471
|
+
/**
|
|
18472
|
+
*
|
|
18473
|
+
* @type {boolean}
|
|
18474
|
+
* @memberof DataTypesFilterSchemaField
|
|
18475
|
+
*/
|
|
18476
|
+
'facetable'?: boolean;
|
|
18477
|
+
/**
|
|
18478
|
+
* \"categorical\", \"numeric\", \"boolean\"
|
|
18479
|
+
* @type {string}
|
|
18480
|
+
* @memberof DataTypesFilterSchemaField
|
|
18481
|
+
*/
|
|
18482
|
+
'filter_type'?: string;
|
|
18483
|
+
/**
|
|
18484
|
+
*
|
|
18485
|
+
* @type {string}
|
|
18486
|
+
* @memberof DataTypesFilterSchemaField
|
|
18487
|
+
*/
|
|
18488
|
+
'name'?: string;
|
|
18489
|
+
/**
|
|
18490
|
+
*
|
|
18491
|
+
* @type {Array<DataTypesFacetRange>}
|
|
18492
|
+
* @memberof DataTypesFilterSchemaField
|
|
18493
|
+
*/
|
|
18494
|
+
'ranges'?: Array<DataTypesFacetRange>;
|
|
18495
|
+
/**
|
|
18496
|
+
*
|
|
18497
|
+
* @type {boolean}
|
|
18498
|
+
* @memberof DataTypesFilterSchemaField
|
|
18499
|
+
*/
|
|
18500
|
+
'sortable'?: boolean;
|
|
18501
|
+
/**
|
|
18502
|
+
*
|
|
18503
|
+
* @type {string}
|
|
18504
|
+
* @memberof DataTypesFilterSchemaField
|
|
18505
|
+
*/
|
|
18506
|
+
'type'?: string;
|
|
18507
|
+
}
|
|
18508
|
+
/**
|
|
18509
|
+
*
|
|
18510
|
+
* @export
|
|
18511
|
+
* @interface DataTypesFilterStats
|
|
18512
|
+
*/
|
|
18513
|
+
export interface DataTypesFilterStats {
|
|
18514
|
+
/**
|
|
18515
|
+
*
|
|
18516
|
+
* @type {number}
|
|
18517
|
+
* @memberof DataTypesFilterStats
|
|
18518
|
+
*/
|
|
18519
|
+
'avg'?: number;
|
|
18520
|
+
/**
|
|
18521
|
+
*
|
|
18522
|
+
* @type {number}
|
|
18523
|
+
* @memberof DataTypesFilterStats
|
|
18524
|
+
*/
|
|
18525
|
+
'max'?: number;
|
|
18526
|
+
/**
|
|
18527
|
+
*
|
|
18528
|
+
* @type {number}
|
|
18529
|
+
* @memberof DataTypesFilterStats
|
|
18530
|
+
*/
|
|
18531
|
+
'min'?: number;
|
|
18532
|
+
/**
|
|
18533
|
+
*
|
|
18534
|
+
* @type {number}
|
|
18535
|
+
* @memberof DataTypesFilterStats
|
|
18536
|
+
*/
|
|
18537
|
+
'sum'?: number;
|
|
18538
|
+
}
|
|
18539
|
+
/**
|
|
18540
|
+
*
|
|
18541
|
+
* @export
|
|
18542
|
+
* @interface DataTypesFilterValue
|
|
18543
|
+
*/
|
|
18544
|
+
export interface DataTypesFilterValue {
|
|
18545
|
+
/**
|
|
18546
|
+
*
|
|
18547
|
+
* @type {number}
|
|
18548
|
+
* @memberof DataTypesFilterValue
|
|
18549
|
+
*/
|
|
18550
|
+
'count'?: number;
|
|
18551
|
+
/**
|
|
18552
|
+
*
|
|
18553
|
+
* @type {string}
|
|
18554
|
+
* @memberof DataTypesFilterValue
|
|
18555
|
+
*/
|
|
18556
|
+
'highlighted'?: string;
|
|
18557
|
+
/**
|
|
18558
|
+
*
|
|
18559
|
+
* @type {string}
|
|
18560
|
+
* @memberof DataTypesFilterValue
|
|
18561
|
+
*/
|
|
18562
|
+
'value'?: string;
|
|
18563
|
+
}
|
|
17328
18564
|
/**
|
|
17329
18565
|
*
|
|
17330
18566
|
* @export
|
|
@@ -17382,6 +18618,137 @@ export interface DataTypesFilteredTabConfig {
|
|
|
17382
18618
|
*/
|
|
17383
18619
|
'sort_by'?: string;
|
|
17384
18620
|
}
|
|
18621
|
+
/**
|
|
18622
|
+
*
|
|
18623
|
+
* @export
|
|
18624
|
+
* @interface DataTypesFiltersRequest
|
|
18625
|
+
*/
|
|
18626
|
+
export interface DataTypesFiltersRequest {
|
|
18627
|
+
/**
|
|
18628
|
+
*
|
|
18629
|
+
* @type {Array<string>}
|
|
18630
|
+
* @memberof DataTypesFiltersRequest
|
|
18631
|
+
*/
|
|
18632
|
+
'disjunctive_facets'?: Array<string>;
|
|
18633
|
+
/**
|
|
18634
|
+
*
|
|
18635
|
+
* @type {string}
|
|
18636
|
+
* @memberof DataTypesFiltersRequest
|
|
18637
|
+
*/
|
|
18638
|
+
'facet_by'?: string;
|
|
18639
|
+
/**
|
|
18640
|
+
*
|
|
18641
|
+
* @type {string}
|
|
18642
|
+
* @memberof DataTypesFiltersRequest
|
|
18643
|
+
*/
|
|
18644
|
+
'filter'?: string;
|
|
18645
|
+
/**
|
|
18646
|
+
*
|
|
18647
|
+
* @type {number}
|
|
18648
|
+
* @memberof DataTypesFiltersRequest
|
|
18649
|
+
*/
|
|
18650
|
+
'max_facet_values'?: number;
|
|
18651
|
+
/**
|
|
18652
|
+
*
|
|
18653
|
+
* @type {string}
|
|
18654
|
+
* @memberof DataTypesFiltersRequest
|
|
18655
|
+
*/
|
|
18656
|
+
'q'?: string;
|
|
18657
|
+
}
|
|
18658
|
+
/**
|
|
18659
|
+
*
|
|
18660
|
+
* @export
|
|
18661
|
+
* @interface DataTypesFiltersResponse
|
|
18662
|
+
*/
|
|
18663
|
+
export interface DataTypesFiltersResponse {
|
|
18664
|
+
/**
|
|
18665
|
+
*
|
|
18666
|
+
* @type {Array<DataTypesFilterField>}
|
|
18667
|
+
* @memberof DataTypesFiltersResponse
|
|
18668
|
+
*/
|
|
18669
|
+
'filters'?: Array<DataTypesFilterField>;
|
|
18670
|
+
/**
|
|
18671
|
+
*
|
|
18672
|
+
* @type {number}
|
|
18673
|
+
* @memberof DataTypesFiltersResponse
|
|
18674
|
+
*/
|
|
18675
|
+
'total_results'?: number;
|
|
18676
|
+
}
|
|
18677
|
+
/**
|
|
18678
|
+
*
|
|
18679
|
+
* @export
|
|
18680
|
+
* @interface DataTypesFiltersResponseWrapper
|
|
18681
|
+
*/
|
|
18682
|
+
export interface DataTypesFiltersResponseWrapper {
|
|
18683
|
+
/**
|
|
18684
|
+
*
|
|
18685
|
+
* @type {DataTypesFiltersResponse}
|
|
18686
|
+
* @memberof DataTypesFiltersResponseWrapper
|
|
18687
|
+
*/
|
|
18688
|
+
'data'?: DataTypesFiltersResponse;
|
|
18689
|
+
/**
|
|
18690
|
+
*
|
|
18691
|
+
* @type {string}
|
|
18692
|
+
* @memberof DataTypesFiltersResponseWrapper
|
|
18693
|
+
*/
|
|
18694
|
+
'message'?: string;
|
|
18695
|
+
/**
|
|
18696
|
+
*
|
|
18697
|
+
* @type {number}
|
|
18698
|
+
* @memberof DataTypesFiltersResponseWrapper
|
|
18699
|
+
*/
|
|
18700
|
+
'status'?: number;
|
|
18701
|
+
}
|
|
18702
|
+
/**
|
|
18703
|
+
*
|
|
18704
|
+
* @export
|
|
18705
|
+
* @interface DataTypesFiltersSchemaResponse
|
|
18706
|
+
*/
|
|
18707
|
+
export interface DataTypesFiltersSchemaResponse {
|
|
18708
|
+
/**
|
|
18709
|
+
*
|
|
18710
|
+
* @type {Array<string>}
|
|
18711
|
+
* @memberof DataTypesFiltersSchemaResponse
|
|
18712
|
+
*/
|
|
18713
|
+
'default_facets'?: Array<string>;
|
|
18714
|
+
/**
|
|
18715
|
+
*
|
|
18716
|
+
* @type {Array<DataTypesFilterSchemaField>}
|
|
18717
|
+
* @memberof DataTypesFiltersSchemaResponse
|
|
18718
|
+
*/
|
|
18719
|
+
'fields'?: Array<DataTypesFilterSchemaField>;
|
|
18720
|
+
/**
|
|
18721
|
+
*
|
|
18722
|
+
* @type {number}
|
|
18723
|
+
* @memberof DataTypesFiltersSchemaResponse
|
|
18724
|
+
*/
|
|
18725
|
+
'max_facet_values'?: number;
|
|
18726
|
+
}
|
|
18727
|
+
/**
|
|
18728
|
+
*
|
|
18729
|
+
* @export
|
|
18730
|
+
* @interface DataTypesFiltersSchemaResponseWrapper
|
|
18731
|
+
*/
|
|
18732
|
+
export interface DataTypesFiltersSchemaResponseWrapper {
|
|
18733
|
+
/**
|
|
18734
|
+
*
|
|
18735
|
+
* @type {DataTypesFiltersSchemaResponse}
|
|
18736
|
+
* @memberof DataTypesFiltersSchemaResponseWrapper
|
|
18737
|
+
*/
|
|
18738
|
+
'data'?: DataTypesFiltersSchemaResponse;
|
|
18739
|
+
/**
|
|
18740
|
+
*
|
|
18741
|
+
* @type {string}
|
|
18742
|
+
* @memberof DataTypesFiltersSchemaResponseWrapper
|
|
18743
|
+
*/
|
|
18744
|
+
'message'?: string;
|
|
18745
|
+
/**
|
|
18746
|
+
*
|
|
18747
|
+
* @type {number}
|
|
18748
|
+
* @memberof DataTypesFiltersSchemaResponseWrapper
|
|
18749
|
+
*/
|
|
18750
|
+
'status'?: number;
|
|
18751
|
+
}
|
|
17385
18752
|
/**
|
|
17386
18753
|
*
|
|
17387
18754
|
* @export
|
|
@@ -17812,6 +19179,56 @@ export interface DataTypesGenericResponseAnalyticsConversionMetrics {
|
|
|
17812
19179
|
*/
|
|
17813
19180
|
'status'?: number;
|
|
17814
19181
|
}
|
|
19182
|
+
/**
|
|
19183
|
+
*
|
|
19184
|
+
* @export
|
|
19185
|
+
* @interface DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
|
|
19186
|
+
*/
|
|
19187
|
+
export interface DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown {
|
|
19188
|
+
/**
|
|
19189
|
+
*
|
|
19190
|
+
* @type {AnalyticsCustomEventFieldBreakdown}
|
|
19191
|
+
* @memberof DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
|
|
19192
|
+
*/
|
|
19193
|
+
'data'?: AnalyticsCustomEventFieldBreakdown;
|
|
19194
|
+
/**
|
|
19195
|
+
*
|
|
19196
|
+
* @type {string}
|
|
19197
|
+
* @memberof DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
|
|
19198
|
+
*/
|
|
19199
|
+
'message'?: string;
|
|
19200
|
+
/**
|
|
19201
|
+
*
|
|
19202
|
+
* @type {number}
|
|
19203
|
+
* @memberof DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown
|
|
19204
|
+
*/
|
|
19205
|
+
'status'?: number;
|
|
19206
|
+
}
|
|
19207
|
+
/**
|
|
19208
|
+
*
|
|
19209
|
+
* @export
|
|
19210
|
+
* @interface DataTypesGenericResponseAnalyticsCustomEventMetrics
|
|
19211
|
+
*/
|
|
19212
|
+
export interface DataTypesGenericResponseAnalyticsCustomEventMetrics {
|
|
19213
|
+
/**
|
|
19214
|
+
*
|
|
19215
|
+
* @type {AnalyticsCustomEventMetrics}
|
|
19216
|
+
* @memberof DataTypesGenericResponseAnalyticsCustomEventMetrics
|
|
19217
|
+
*/
|
|
19218
|
+
'data'?: AnalyticsCustomEventMetrics;
|
|
19219
|
+
/**
|
|
19220
|
+
*
|
|
19221
|
+
* @type {string}
|
|
19222
|
+
* @memberof DataTypesGenericResponseAnalyticsCustomEventMetrics
|
|
19223
|
+
*/
|
|
19224
|
+
'message'?: string;
|
|
19225
|
+
/**
|
|
19226
|
+
*
|
|
19227
|
+
* @type {number}
|
|
19228
|
+
* @memberof DataTypesGenericResponseAnalyticsCustomEventMetrics
|
|
19229
|
+
*/
|
|
19230
|
+
'status'?: number;
|
|
19231
|
+
}
|
|
17815
19232
|
/**
|
|
17816
19233
|
*
|
|
17817
19234
|
* @export
|
|
@@ -17962,6 +19379,31 @@ export interface DataTypesGenericResponseAnalyticsModelComparisonResponse {
|
|
|
17962
19379
|
*/
|
|
17963
19380
|
'status'?: number;
|
|
17964
19381
|
}
|
|
19382
|
+
/**
|
|
19383
|
+
*
|
|
19384
|
+
* @export
|
|
19385
|
+
* @interface DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
19386
|
+
*/
|
|
19387
|
+
export interface DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow {
|
|
19388
|
+
/**
|
|
19389
|
+
*
|
|
19390
|
+
* @type {AnalyticsPaginatedResponseAnalyticsCustomEventRow}
|
|
19391
|
+
* @memberof DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
19392
|
+
*/
|
|
19393
|
+
'data'?: AnalyticsPaginatedResponseAnalyticsCustomEventRow;
|
|
19394
|
+
/**
|
|
19395
|
+
*
|
|
19396
|
+
* @type {string}
|
|
19397
|
+
* @memberof DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
19398
|
+
*/
|
|
19399
|
+
'message'?: string;
|
|
19400
|
+
/**
|
|
19401
|
+
*
|
|
19402
|
+
* @type {number}
|
|
19403
|
+
* @memberof DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow
|
|
19404
|
+
*/
|
|
19405
|
+
'status'?: number;
|
|
19406
|
+
}
|
|
17965
19407
|
/**
|
|
17966
19408
|
*
|
|
17967
19409
|
* @export
|
|
@@ -18187,6 +19629,56 @@ export interface DataTypesGenericResponseAny {
|
|
|
18187
19629
|
*/
|
|
18188
19630
|
'status'?: number;
|
|
18189
19631
|
}
|
|
19632
|
+
/**
|
|
19633
|
+
*
|
|
19634
|
+
* @export
|
|
19635
|
+
* @interface DataTypesGenericResponseArrayAnalyticsCustomEventSummary
|
|
19636
|
+
*/
|
|
19637
|
+
export interface DataTypesGenericResponseArrayAnalyticsCustomEventSummary {
|
|
19638
|
+
/**
|
|
19639
|
+
*
|
|
19640
|
+
* @type {Array<AnalyticsCustomEventSummary>}
|
|
19641
|
+
* @memberof DataTypesGenericResponseArrayAnalyticsCustomEventSummary
|
|
19642
|
+
*/
|
|
19643
|
+
'data'?: Array<AnalyticsCustomEventSummary>;
|
|
19644
|
+
/**
|
|
19645
|
+
*
|
|
19646
|
+
* @type {string}
|
|
19647
|
+
* @memberof DataTypesGenericResponseArrayAnalyticsCustomEventSummary
|
|
19648
|
+
*/
|
|
19649
|
+
'message'?: string;
|
|
19650
|
+
/**
|
|
19651
|
+
*
|
|
19652
|
+
* @type {number}
|
|
19653
|
+
* @memberof DataTypesGenericResponseArrayAnalyticsCustomEventSummary
|
|
19654
|
+
*/
|
|
19655
|
+
'status'?: number;
|
|
19656
|
+
}
|
|
19657
|
+
/**
|
|
19658
|
+
*
|
|
19659
|
+
* @export
|
|
19660
|
+
* @interface DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
|
|
19661
|
+
*/
|
|
19662
|
+
export interface DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint {
|
|
19663
|
+
/**
|
|
19664
|
+
*
|
|
19665
|
+
* @type {Array<AnalyticsCustomEventTimeSeriesPoint>}
|
|
19666
|
+
* @memberof DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
|
|
19667
|
+
*/
|
|
19668
|
+
'data'?: Array<AnalyticsCustomEventTimeSeriesPoint>;
|
|
19669
|
+
/**
|
|
19670
|
+
*
|
|
19671
|
+
* @type {string}
|
|
19672
|
+
* @memberof DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
|
|
19673
|
+
*/
|
|
19674
|
+
'message'?: string;
|
|
19675
|
+
/**
|
|
19676
|
+
*
|
|
19677
|
+
* @type {number}
|
|
19678
|
+
* @memberof DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint
|
|
19679
|
+
*/
|
|
19680
|
+
'status'?: number;
|
|
19681
|
+
}
|
|
18190
19682
|
/**
|
|
18191
19683
|
*
|
|
18192
19684
|
* @export
|
|
@@ -19734,6 +21226,12 @@ export interface DataTypesIndexConfig {
|
|
|
19734
21226
|
* @memberof DataTypesIndexConfig
|
|
19735
21227
|
*/
|
|
19736
21228
|
'enable_smart_autocomplete'?: boolean;
|
|
21229
|
+
/**
|
|
21230
|
+
* Enable stemming on search collections
|
|
21231
|
+
* @type {boolean}
|
|
21232
|
+
* @memberof DataTypesIndexConfig
|
|
21233
|
+
*/
|
|
21234
|
+
'enable_stemming'?: boolean;
|
|
19737
21235
|
/**
|
|
19738
21236
|
*
|
|
19739
21237
|
* @type {boolean}
|
|
@@ -19998,6 +21496,12 @@ export interface DataTypesIndexConfig {
|
|
|
19998
21496
|
* @memberof DataTypesIndexConfig
|
|
19999
21497
|
*/
|
|
20000
21498
|
'sort_by'?: Array<DataTypesSortField>;
|
|
21499
|
+
/**
|
|
21500
|
+
* Locale for stemming (e.g., \"en\", \"fr\", \"de\")
|
|
21501
|
+
* @type {string}
|
|
21502
|
+
* @memberof DataTypesIndexConfig
|
|
21503
|
+
*/
|
|
21504
|
+
'stemming_locale'?: string;
|
|
20001
21505
|
/**
|
|
20002
21506
|
* Flattened stopwords and synonyms fields
|
|
20003
21507
|
* @type {Array<DataTypesStopwordEntry>}
|
|
@@ -27763,6 +29267,12 @@ export interface DataTypesSchemaBasedDefaults {
|
|
|
27763
29267
|
* @memberof DataTypesSchemaBasedDefaults
|
|
27764
29268
|
*/
|
|
27765
29269
|
'include_fields'?: Array<string>;
|
|
29270
|
+
/**
|
|
29271
|
+
*
|
|
29272
|
+
* @type {Array<string>}
|
|
29273
|
+
* @memberof DataTypesSchemaBasedDefaults
|
|
29274
|
+
*/
|
|
29275
|
+
'numeric_facetable_fields'?: Array<string>;
|
|
27766
29276
|
/**
|
|
27767
29277
|
*
|
|
27768
29278
|
* @type {Array<string>}
|
|
@@ -31314,6 +32824,85 @@ export interface DataTypesUpdateCustomWordListRequest {
|
|
|
31314
32824
|
*/
|
|
31315
32825
|
'words'?: Array<string>;
|
|
31316
32826
|
}
|
|
32827
|
+
/**
|
|
32828
|
+
*
|
|
32829
|
+
* @export
|
|
32830
|
+
* @interface DataTypesUpdateExperimentRequest
|
|
32831
|
+
*/
|
|
32832
|
+
export interface DataTypesUpdateExperimentRequest {
|
|
32833
|
+
/**
|
|
32834
|
+
*
|
|
32835
|
+
* @type {object}
|
|
32836
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32837
|
+
*/
|
|
32838
|
+
'audience_filter'?: object;
|
|
32839
|
+
/**
|
|
32840
|
+
*
|
|
32841
|
+
* @type {string}
|
|
32842
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32843
|
+
*/
|
|
32844
|
+
'description'?: string;
|
|
32845
|
+
/**
|
|
32846
|
+
*
|
|
32847
|
+
* @type {string}
|
|
32848
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32849
|
+
*/
|
|
32850
|
+
'hypothesis'?: string;
|
|
32851
|
+
/**
|
|
32852
|
+
*
|
|
32853
|
+
* @type {number}
|
|
32854
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32855
|
+
*/
|
|
32856
|
+
'max_duration_days'?: number;
|
|
32857
|
+
/**
|
|
32858
|
+
*
|
|
32859
|
+
* @type {number}
|
|
32860
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32861
|
+
*/
|
|
32862
|
+
'min_sample_size'?: number;
|
|
32863
|
+
/**
|
|
32864
|
+
*
|
|
32865
|
+
* @type {string}
|
|
32866
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32867
|
+
*/
|
|
32868
|
+
'name'?: string;
|
|
32869
|
+
/**
|
|
32870
|
+
*
|
|
32871
|
+
* @type {string}
|
|
32872
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32873
|
+
*/
|
|
32874
|
+
'primary_metric'?: string;
|
|
32875
|
+
/**
|
|
32876
|
+
*
|
|
32877
|
+
* @type {string}
|
|
32878
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32879
|
+
*/
|
|
32880
|
+
'scheduled_end_at'?: string;
|
|
32881
|
+
/**
|
|
32882
|
+
*
|
|
32883
|
+
* @type {string}
|
|
32884
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32885
|
+
*/
|
|
32886
|
+
'scheduled_start_at'?: string;
|
|
32887
|
+
/**
|
|
32888
|
+
*
|
|
32889
|
+
* @type {Array<string>}
|
|
32890
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32891
|
+
*/
|
|
32892
|
+
'secondary_metrics'?: Array<string>;
|
|
32893
|
+
/**
|
|
32894
|
+
*
|
|
32895
|
+
* @type {number}
|
|
32896
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32897
|
+
*/
|
|
32898
|
+
'traffic_percentage'?: number;
|
|
32899
|
+
/**
|
|
32900
|
+
*
|
|
32901
|
+
* @type {Array<DataTypesExperimentVariant>}
|
|
32902
|
+
* @memberof DataTypesUpdateExperimentRequest
|
|
32903
|
+
*/
|
|
32904
|
+
'variants'?: Array<DataTypesExperimentVariant>;
|
|
32905
|
+
}
|
|
31317
32906
|
/**
|
|
31318
32907
|
*
|
|
31319
32908
|
* @export
|
|
@@ -34216,6 +35805,12 @@ export interface ModelsCreateCustomEventFieldRequest {
|
|
|
34216
35805
|
* @memberof ModelsCreateCustomEventFieldRequest
|
|
34217
35806
|
*/
|
|
34218
35807
|
'allowed_values'?: Array<string>;
|
|
35808
|
+
/**
|
|
35809
|
+
* for array type: string, number, boolean, datetime, object, mixed
|
|
35810
|
+
* @type {string}
|
|
35811
|
+
* @memberof ModelsCreateCustomEventFieldRequest
|
|
35812
|
+
*/
|
|
35813
|
+
'array_item_type'?: string;
|
|
34219
35814
|
/**
|
|
34220
35815
|
*
|
|
34221
35816
|
* @type {string}
|
|
@@ -34396,12 +35991,66 @@ export interface ModelsMergeProfilesResponse {
|
|
|
34396
35991
|
* @interface ModelsNestedPropertyDefinition
|
|
34397
35992
|
*/
|
|
34398
35993
|
export interface ModelsNestedPropertyDefinition {
|
|
35994
|
+
/**
|
|
35995
|
+
*
|
|
35996
|
+
* @type {Array<any>}
|
|
35997
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
35998
|
+
*/
|
|
35999
|
+
'allowed_values'?: Array<any>;
|
|
36000
|
+
/**
|
|
36001
|
+
* if array_item_type is object
|
|
36002
|
+
* @type {ModelsNestedPropertyDefinition}
|
|
36003
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36004
|
+
*/
|
|
36005
|
+
'array_item_schema'?: ModelsNestedPropertyDefinition;
|
|
36006
|
+
/**
|
|
36007
|
+
* For array type: define the type of array items
|
|
36008
|
+
* @type {string}
|
|
36009
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36010
|
+
*/
|
|
36011
|
+
'array_item_type'?: string;
|
|
36012
|
+
/**
|
|
36013
|
+
*
|
|
36014
|
+
* @type {string}
|
|
36015
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36016
|
+
*/
|
|
36017
|
+
'description'?: string;
|
|
36018
|
+
/**
|
|
36019
|
+
* string max length / array max items
|
|
36020
|
+
* @type {number}
|
|
36021
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36022
|
+
*/
|
|
36023
|
+
'max_length'?: number;
|
|
36024
|
+
/**
|
|
36025
|
+
*
|
|
36026
|
+
* @type {number}
|
|
36027
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36028
|
+
*/
|
|
36029
|
+
'max_value'?: number;
|
|
36030
|
+
/**
|
|
36031
|
+
* string min length / array min items
|
|
36032
|
+
* @type {number}
|
|
36033
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36034
|
+
*/
|
|
36035
|
+
'min_length'?: number;
|
|
36036
|
+
/**
|
|
36037
|
+
*
|
|
36038
|
+
* @type {number}
|
|
36039
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36040
|
+
*/
|
|
36041
|
+
'min_value'?: number;
|
|
34399
36042
|
/**
|
|
34400
36043
|
*
|
|
34401
36044
|
* @type {string}
|
|
34402
36045
|
* @memberof ModelsNestedPropertyDefinition
|
|
34403
36046
|
*/
|
|
34404
36047
|
'name'?: string;
|
|
36048
|
+
/**
|
|
36049
|
+
* For object type: nested properties (recursive)
|
|
36050
|
+
* @type {Array<ModelsNestedPropertyDefinition>}
|
|
36051
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36052
|
+
*/
|
|
36053
|
+
'properties'?: Array<ModelsNestedPropertyDefinition>;
|
|
34405
36054
|
/**
|
|
34406
36055
|
*
|
|
34407
36056
|
* @type {boolean}
|
|
@@ -34414,6 +36063,12 @@ export interface ModelsNestedPropertyDefinition {
|
|
|
34414
36063
|
* @memberof ModelsNestedPropertyDefinition
|
|
34415
36064
|
*/
|
|
34416
36065
|
'type'?: string;
|
|
36066
|
+
/**
|
|
36067
|
+
* Validation for string/number/array types
|
|
36068
|
+
* @type {string}
|
|
36069
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
36070
|
+
*/
|
|
36071
|
+
'validation_regex'?: string;
|
|
34417
36072
|
}
|
|
34418
36073
|
/**
|
|
34419
36074
|
*
|
|
@@ -34567,6 +36222,12 @@ export interface ModelsUpdateCustomEventFieldRequest {
|
|
|
34567
36222
|
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
34568
36223
|
*/
|
|
34569
36224
|
'allowed_values'?: Array<string>;
|
|
36225
|
+
/**
|
|
36226
|
+
* for array type: string, number, boolean, datetime, object, mixed
|
|
36227
|
+
* @type {string}
|
|
36228
|
+
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
36229
|
+
*/
|
|
36230
|
+
'array_item_type'?: string;
|
|
34570
36231
|
/**
|
|
34571
36232
|
*
|
|
34572
36233
|
* @type {string}
|
|
@@ -35886,6 +37547,12 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
|
|
|
35886
37547
|
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
35887
37548
|
*/
|
|
35888
37549
|
'enable_rules'?: boolean;
|
|
37550
|
+
/**
|
|
37551
|
+
* Stemming configuration
|
|
37552
|
+
* @type {boolean}
|
|
37553
|
+
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
37554
|
+
*/
|
|
37555
|
+
'enable_stemming'?: boolean;
|
|
35889
37556
|
/**
|
|
35890
37557
|
* Whether query suggestions are enabled for the store
|
|
35891
37558
|
* @type {boolean}
|
|
@@ -35958,6 +37625,12 @@ export interface QuerySuggestionsServiceQuerySuggestionConfig {
|
|
|
35958
37625
|
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
35959
37626
|
*/
|
|
35960
37627
|
'special_chars'?: boolean;
|
|
37628
|
+
/**
|
|
37629
|
+
* Locale for stemming (derived from Languages[0], fallback \"en\")
|
|
37630
|
+
* @type {string}
|
|
37631
|
+
* @memberof QuerySuggestionsServiceQuerySuggestionConfig
|
|
37632
|
+
*/
|
|
37633
|
+
'stemming_locale'?: string;
|
|
35961
37634
|
/**
|
|
35962
37635
|
* Whether to sync enabled suggestions to Typesense
|
|
35963
37636
|
* @type {boolean}
|
|
@@ -36922,6 +38595,12 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
|
|
|
36922
38595
|
* @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
|
|
36923
38596
|
*/
|
|
36924
38597
|
'enable_rules'?: boolean;
|
|
38598
|
+
/**
|
|
38599
|
+
* Enable stemming on query suggestions collection
|
|
38600
|
+
* @type {boolean}
|
|
38601
|
+
* @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
|
|
38602
|
+
*/
|
|
38603
|
+
'enable_stemming'?: boolean;
|
|
36925
38604
|
/**
|
|
36926
38605
|
* Enable/disable query suggestions for the store
|
|
36927
38606
|
* @type {boolean}
|
|
@@ -36976,6 +38655,12 @@ export interface QuerySuggestionsServiceUpdateSuggestionConfigRequest {
|
|
|
36976
38655
|
* @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
|
|
36977
38656
|
*/
|
|
36978
38657
|
'special_chars'?: boolean;
|
|
38658
|
+
/**
|
|
38659
|
+
* Locale for stemming
|
|
38660
|
+
* @type {string}
|
|
38661
|
+
* @memberof QuerySuggestionsServiceUpdateSuggestionConfigRequest
|
|
38662
|
+
*/
|
|
38663
|
+
'stemming_locale'?: string;
|
|
36979
38664
|
/**
|
|
36980
38665
|
* Enable/disable syncing suggestions to Typesense
|
|
36981
38666
|
* @type {boolean}
|
|
@@ -49159,6 +50844,237 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
49159
50844
|
[key: string]: any;
|
|
49160
50845
|
}, any, {}>>;
|
|
49161
50846
|
}
|
|
50847
|
+
/**
|
|
50848
|
+
* CustomEventsAnalyticsApi - axios parameter creator
|
|
50849
|
+
* @export
|
|
50850
|
+
*/
|
|
50851
|
+
export declare const CustomEventsAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
50852
|
+
/**
|
|
50853
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
50854
|
+
* @summary Get Custom Event Field Breakdown
|
|
50855
|
+
* @param {string} xStoreID Store ID
|
|
50856
|
+
* @param {string} authorization Bearer JWT token
|
|
50857
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
50858
|
+
* @param {*} [options] Override http request option.
|
|
50859
|
+
* @throws {RequiredError}
|
|
50860
|
+
*/
|
|
50861
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost: (xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50862
|
+
/**
|
|
50863
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
50864
|
+
* @summary Get Custom Event Metrics
|
|
50865
|
+
* @param {string} xStoreID Store ID
|
|
50866
|
+
* @param {string} authorization Bearer JWT token
|
|
50867
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
50868
|
+
* @param {*} [options] Override http request option.
|
|
50869
|
+
* @throws {RequiredError}
|
|
50870
|
+
*/
|
|
50871
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost: (xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50872
|
+
/**
|
|
50873
|
+
* Returns paginated raw custom events with field data
|
|
50874
|
+
* @summary Get Custom Event Stream
|
|
50875
|
+
* @param {string} xStoreID Store ID
|
|
50876
|
+
* @param {string} authorization Bearer JWT token
|
|
50877
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
50878
|
+
* @param {*} [options] Override http request option.
|
|
50879
|
+
* @throws {RequiredError}
|
|
50880
|
+
*/
|
|
50881
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost: (xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50882
|
+
/**
|
|
50883
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
50884
|
+
* @summary Get Custom Event Time Series
|
|
50885
|
+
* @param {string} xStoreID Store ID
|
|
50886
|
+
* @param {string} authorization Bearer JWT token
|
|
50887
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
50888
|
+
* @param {*} [options] Override http request option.
|
|
50889
|
+
* @throws {RequiredError}
|
|
50890
|
+
*/
|
|
50891
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost: (xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50892
|
+
/**
|
|
50893
|
+
* Returns the top custom events by count or unique users
|
|
50894
|
+
* @summary Get Top Custom Events
|
|
50895
|
+
* @param {string} xStoreID Store ID
|
|
50896
|
+
* @param {string} authorization Bearer JWT token
|
|
50897
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
50898
|
+
* @param {*} [options] Override http request option.
|
|
50899
|
+
* @throws {RequiredError}
|
|
50900
|
+
*/
|
|
50901
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost: (xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50902
|
+
};
|
|
50903
|
+
/**
|
|
50904
|
+
* CustomEventsAnalyticsApi - functional programming interface
|
|
50905
|
+
* @export
|
|
50906
|
+
*/
|
|
50907
|
+
export declare const CustomEventsAnalyticsApiFp: (configuration?: Configuration) => {
|
|
50908
|
+
/**
|
|
50909
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
50910
|
+
* @summary Get Custom Event Field Breakdown
|
|
50911
|
+
* @param {string} xStoreID Store ID
|
|
50912
|
+
* @param {string} authorization Bearer JWT token
|
|
50913
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
50914
|
+
* @param {*} [options] Override http request option.
|
|
50915
|
+
* @throws {RequiredError}
|
|
50916
|
+
*/
|
|
50917
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown>>;
|
|
50918
|
+
/**
|
|
50919
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
50920
|
+
* @summary Get Custom Event Metrics
|
|
50921
|
+
* @param {string} xStoreID Store ID
|
|
50922
|
+
* @param {string} authorization Bearer JWT token
|
|
50923
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
50924
|
+
* @param {*} [options] Override http request option.
|
|
50925
|
+
* @throws {RequiredError}
|
|
50926
|
+
*/
|
|
50927
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventMetrics>>;
|
|
50928
|
+
/**
|
|
50929
|
+
* Returns paginated raw custom events with field data
|
|
50930
|
+
* @summary Get Custom Event Stream
|
|
50931
|
+
* @param {string} xStoreID Store ID
|
|
50932
|
+
* @param {string} authorization Bearer JWT token
|
|
50933
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
50934
|
+
* @param {*} [options] Override http request option.
|
|
50935
|
+
* @throws {RequiredError}
|
|
50936
|
+
*/
|
|
50937
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow>>;
|
|
50938
|
+
/**
|
|
50939
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
50940
|
+
* @summary Get Custom Event Time Series
|
|
50941
|
+
* @param {string} xStoreID Store ID
|
|
50942
|
+
* @param {string} authorization Bearer JWT token
|
|
50943
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
50944
|
+
* @param {*} [options] Override http request option.
|
|
50945
|
+
* @throws {RequiredError}
|
|
50946
|
+
*/
|
|
50947
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint>>;
|
|
50948
|
+
/**
|
|
50949
|
+
* Returns the top custom events by count or unique users
|
|
50950
|
+
* @summary Get Top Custom Events
|
|
50951
|
+
* @param {string} xStoreID Store ID
|
|
50952
|
+
* @param {string} authorization Bearer JWT token
|
|
50953
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
50954
|
+
* @param {*} [options] Override http request option.
|
|
50955
|
+
* @throws {RequiredError}
|
|
50956
|
+
*/
|
|
50957
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventSummary>>;
|
|
50958
|
+
};
|
|
50959
|
+
/**
|
|
50960
|
+
* CustomEventsAnalyticsApi - factory interface
|
|
50961
|
+
* @export
|
|
50962
|
+
*/
|
|
50963
|
+
export declare const CustomEventsAnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
50964
|
+
/**
|
|
50965
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
50966
|
+
* @summary Get Custom Event Field Breakdown
|
|
50967
|
+
* @param {string} xStoreID Store ID
|
|
50968
|
+
* @param {string} authorization Bearer JWT token
|
|
50969
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
50970
|
+
* @param {*} [options] Override http request option.
|
|
50971
|
+
* @throws {RequiredError}
|
|
50972
|
+
*/
|
|
50973
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown>;
|
|
50974
|
+
/**
|
|
50975
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
50976
|
+
* @summary Get Custom Event Metrics
|
|
50977
|
+
* @param {string} xStoreID Store ID
|
|
50978
|
+
* @param {string} authorization Bearer JWT token
|
|
50979
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
50980
|
+
* @param {*} [options] Override http request option.
|
|
50981
|
+
* @throws {RequiredError}
|
|
50982
|
+
*/
|
|
50983
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAnalyticsCustomEventMetrics>;
|
|
50984
|
+
/**
|
|
50985
|
+
* Returns paginated raw custom events with field data
|
|
50986
|
+
* @summary Get Custom Event Stream
|
|
50987
|
+
* @param {string} xStoreID Store ID
|
|
50988
|
+
* @param {string} authorization Bearer JWT token
|
|
50989
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
50990
|
+
* @param {*} [options] Override http request option.
|
|
50991
|
+
* @throws {RequiredError}
|
|
50992
|
+
*/
|
|
50993
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow>;
|
|
50994
|
+
/**
|
|
50995
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
50996
|
+
* @summary Get Custom Event Time Series
|
|
50997
|
+
* @param {string} xStoreID Store ID
|
|
50998
|
+
* @param {string} authorization Bearer JWT token
|
|
50999
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
51000
|
+
* @param {*} [options] Override http request option.
|
|
51001
|
+
* @throws {RequiredError}
|
|
51002
|
+
*/
|
|
51003
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint>;
|
|
51004
|
+
/**
|
|
51005
|
+
* Returns the top custom events by count or unique users
|
|
51006
|
+
* @summary Get Top Custom Events
|
|
51007
|
+
* @param {string} xStoreID Store ID
|
|
51008
|
+
* @param {string} authorization Bearer JWT token
|
|
51009
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
51010
|
+
* @param {*} [options] Override http request option.
|
|
51011
|
+
* @throws {RequiredError}
|
|
51012
|
+
*/
|
|
51013
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayAnalyticsCustomEventSummary>;
|
|
51014
|
+
};
|
|
51015
|
+
/**
|
|
51016
|
+
* CustomEventsAnalyticsApi - object-oriented interface
|
|
51017
|
+
* @export
|
|
51018
|
+
* @class CustomEventsAnalyticsApi
|
|
51019
|
+
* @extends {BaseAPI}
|
|
51020
|
+
*/
|
|
51021
|
+
export declare class CustomEventsAnalyticsApi extends BaseAPI {
|
|
51022
|
+
/**
|
|
51023
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
51024
|
+
* @summary Get Custom Event Field Breakdown
|
|
51025
|
+
* @param {string} xStoreID Store ID
|
|
51026
|
+
* @param {string} authorization Bearer JWT token
|
|
51027
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
51028
|
+
* @param {*} [options] Override http request option.
|
|
51029
|
+
* @throws {RequiredError}
|
|
51030
|
+
* @memberof CustomEventsAnalyticsApi
|
|
51031
|
+
*/
|
|
51032
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID: string, authorization: string, analyticsCustomEventFieldBreakdownRequestBody: AnalyticsCustomEventFieldBreakdownRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAnalyticsCustomEventFieldBreakdown, any, {}>>;
|
|
51033
|
+
/**
|
|
51034
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
51035
|
+
* @summary Get Custom Event Metrics
|
|
51036
|
+
* @param {string} xStoreID Store ID
|
|
51037
|
+
* @param {string} authorization Bearer JWT token
|
|
51038
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
51039
|
+
* @param {*} [options] Override http request option.
|
|
51040
|
+
* @throws {RequiredError}
|
|
51041
|
+
* @memberof CustomEventsAnalyticsApi
|
|
51042
|
+
*/
|
|
51043
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID: string, authorization: string, analyticsCustomEventMetricsRequestBody: AnalyticsCustomEventMetricsRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAnalyticsCustomEventMetrics, any, {}>>;
|
|
51044
|
+
/**
|
|
51045
|
+
* Returns paginated raw custom events with field data
|
|
51046
|
+
* @summary Get Custom Event Stream
|
|
51047
|
+
* @param {string} xStoreID Store ID
|
|
51048
|
+
* @param {string} authorization Bearer JWT token
|
|
51049
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
51050
|
+
* @param {*} [options] Override http request option.
|
|
51051
|
+
* @throws {RequiredError}
|
|
51052
|
+
* @memberof CustomEventsAnalyticsApi
|
|
51053
|
+
*/
|
|
51054
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID: string, authorization: string, analyticsCustomEventStreamRequestBody: AnalyticsCustomEventStreamRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAnalyticsPaginatedResponseAnalyticsCustomEventRow, any, {}>>;
|
|
51055
|
+
/**
|
|
51056
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
51057
|
+
* @summary Get Custom Event Time Series
|
|
51058
|
+
* @param {string} xStoreID Store ID
|
|
51059
|
+
* @param {string} authorization Bearer JWT token
|
|
51060
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
51061
|
+
* @param {*} [options] Override http request option.
|
|
51062
|
+
* @throws {RequiredError}
|
|
51063
|
+
* @memberof CustomEventsAnalyticsApi
|
|
51064
|
+
*/
|
|
51065
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID: string, authorization: string, analyticsCustomEventTimeSeriesRequestBody: AnalyticsCustomEventTimeSeriesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayAnalyticsCustomEventTimeSeriesPoint, any, {}>>;
|
|
51066
|
+
/**
|
|
51067
|
+
* Returns the top custom events by count or unique users
|
|
51068
|
+
* @summary Get Top Custom Events
|
|
51069
|
+
* @param {string} xStoreID Store ID
|
|
51070
|
+
* @param {string} authorization Bearer JWT token
|
|
51071
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
51072
|
+
* @param {*} [options] Override http request option.
|
|
51073
|
+
* @throws {RequiredError}
|
|
51074
|
+
* @memberof CustomEventsAnalyticsApi
|
|
51075
|
+
*/
|
|
51076
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID: string, authorization: string, analyticsTopCustomEventsRequestBody: AnalyticsTopCustomEventsRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayAnalyticsCustomEventSummary, any, {}>>;
|
|
51077
|
+
}
|
|
49162
51078
|
/**
|
|
49163
51079
|
* CustomStopwordsApi - axios parameter creator
|
|
49164
51080
|
* @export
|
|
@@ -50543,6 +52459,339 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
50543
52459
|
*/
|
|
50544
52460
|
adminStoresXStoreIDUploadPost(xStoreID: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
|
|
50545
52461
|
}
|
|
52462
|
+
/**
|
|
52463
|
+
* ExperimentsApi - axios parameter creator
|
|
52464
|
+
* @export
|
|
52465
|
+
*/
|
|
52466
|
+
export declare const ExperimentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
52467
|
+
/**
|
|
52468
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
52469
|
+
* @summary List all experiments
|
|
52470
|
+
* @param {*} [options] Override http request option.
|
|
52471
|
+
* @throws {RequiredError}
|
|
52472
|
+
*/
|
|
52473
|
+
v1AdminExperimentsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52474
|
+
/**
|
|
52475
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
52476
|
+
* @summary Complete an experiment
|
|
52477
|
+
* @param {string} id Experiment ID (slug)
|
|
52478
|
+
* @param {object} [body] Optional winner variant ID
|
|
52479
|
+
* @param {*} [options] Override http request option.
|
|
52480
|
+
* @throws {RequiredError}
|
|
52481
|
+
*/
|
|
52482
|
+
v1AdminExperimentsIdCompletePost: (id: string, body?: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52483
|
+
/**
|
|
52484
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
52485
|
+
* @summary Delete a draft experiment
|
|
52486
|
+
* @param {string} id Experiment ID (slug)
|
|
52487
|
+
* @param {*} [options] Override http request option.
|
|
52488
|
+
* @throws {RequiredError}
|
|
52489
|
+
*/
|
|
52490
|
+
v1AdminExperimentsIdDelete: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52491
|
+
/**
|
|
52492
|
+
* Returns a single experiment by its experiment_id slug.
|
|
52493
|
+
* @summary Get experiment by ID
|
|
52494
|
+
* @param {string} id Experiment ID (slug)
|
|
52495
|
+
* @param {*} [options] Override http request option.
|
|
52496
|
+
* @throws {RequiredError}
|
|
52497
|
+
*/
|
|
52498
|
+
v1AdminExperimentsIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52499
|
+
/**
|
|
52500
|
+
* Transitions a running experiment to paused status.
|
|
52501
|
+
* @summary Pause an experiment
|
|
52502
|
+
* @param {string} id Experiment ID (slug)
|
|
52503
|
+
* @param {*} [options] Override http request option.
|
|
52504
|
+
* @throws {RequiredError}
|
|
52505
|
+
*/
|
|
52506
|
+
v1AdminExperimentsIdPausePost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52507
|
+
/**
|
|
52508
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
52509
|
+
* @summary Update an experiment
|
|
52510
|
+
* @param {string} id Experiment ID (slug)
|
|
52511
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
52512
|
+
* @param {*} [options] Override http request option.
|
|
52513
|
+
* @throws {RequiredError}
|
|
52514
|
+
*/
|
|
52515
|
+
v1AdminExperimentsIdPut: (id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52516
|
+
/**
|
|
52517
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
52518
|
+
* @summary Get experiment results
|
|
52519
|
+
* @param {string} id Experiment ID (slug)
|
|
52520
|
+
* @param {*} [options] Override http request option.
|
|
52521
|
+
* @throws {RequiredError}
|
|
52522
|
+
*/
|
|
52523
|
+
v1AdminExperimentsIdResultsGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52524
|
+
/**
|
|
52525
|
+
* Transitions a draft or paused experiment to running status.
|
|
52526
|
+
* @summary Start an experiment
|
|
52527
|
+
* @param {string} id Experiment ID (slug)
|
|
52528
|
+
* @param {*} [options] Override http request option.
|
|
52529
|
+
* @throws {RequiredError}
|
|
52530
|
+
*/
|
|
52531
|
+
v1AdminExperimentsIdStartPost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52532
|
+
/**
|
|
52533
|
+
* Creates a new A/B test experiment in draft status.
|
|
52534
|
+
* @summary Create a new experiment
|
|
52535
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
52536
|
+
* @param {*} [options] Override http request option.
|
|
52537
|
+
* @throws {RequiredError}
|
|
52538
|
+
*/
|
|
52539
|
+
v1AdminExperimentsPost: (dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52540
|
+
};
|
|
52541
|
+
/**
|
|
52542
|
+
* ExperimentsApi - functional programming interface
|
|
52543
|
+
* @export
|
|
52544
|
+
*/
|
|
52545
|
+
export declare const ExperimentsApiFp: (configuration?: Configuration) => {
|
|
52546
|
+
/**
|
|
52547
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
52548
|
+
* @summary List all experiments
|
|
52549
|
+
* @param {*} [options] Override http request option.
|
|
52550
|
+
* @throws {RequiredError}
|
|
52551
|
+
*/
|
|
52552
|
+
v1AdminExperimentsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
52553
|
+
[key: string]: Array<DataTypesExperiment>;
|
|
52554
|
+
}>>;
|
|
52555
|
+
/**
|
|
52556
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
52557
|
+
* @summary Complete an experiment
|
|
52558
|
+
* @param {string} id Experiment ID (slug)
|
|
52559
|
+
* @param {object} [body] Optional winner variant ID
|
|
52560
|
+
* @param {*} [options] Override http request option.
|
|
52561
|
+
* @throws {RequiredError}
|
|
52562
|
+
*/
|
|
52563
|
+
v1AdminExperimentsIdCompletePost(id: string, body?: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
52564
|
+
/**
|
|
52565
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
52566
|
+
* @summary Delete a draft experiment
|
|
52567
|
+
* @param {string} id Experiment ID (slug)
|
|
52568
|
+
* @param {*} [options] Override http request option.
|
|
52569
|
+
* @throws {RequiredError}
|
|
52570
|
+
*/
|
|
52571
|
+
v1AdminExperimentsIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
52572
|
+
/**
|
|
52573
|
+
* Returns a single experiment by its experiment_id slug.
|
|
52574
|
+
* @summary Get experiment by ID
|
|
52575
|
+
* @param {string} id Experiment ID (slug)
|
|
52576
|
+
* @param {*} [options] Override http request option.
|
|
52577
|
+
* @throws {RequiredError}
|
|
52578
|
+
*/
|
|
52579
|
+
v1AdminExperimentsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
|
|
52580
|
+
/**
|
|
52581
|
+
* Transitions a running experiment to paused status.
|
|
52582
|
+
* @summary Pause an experiment
|
|
52583
|
+
* @param {string} id Experiment ID (slug)
|
|
52584
|
+
* @param {*} [options] Override http request option.
|
|
52585
|
+
* @throws {RequiredError}
|
|
52586
|
+
*/
|
|
52587
|
+
v1AdminExperimentsIdPausePost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
52588
|
+
/**
|
|
52589
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
52590
|
+
* @summary Update an experiment
|
|
52591
|
+
* @param {string} id Experiment ID (slug)
|
|
52592
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
52593
|
+
* @param {*} [options] Override http request option.
|
|
52594
|
+
* @throws {RequiredError}
|
|
52595
|
+
*/
|
|
52596
|
+
v1AdminExperimentsIdPut(id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
|
|
52597
|
+
/**
|
|
52598
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
52599
|
+
* @summary Get experiment results
|
|
52600
|
+
* @param {string} id Experiment ID (slug)
|
|
52601
|
+
* @param {*} [options] Override http request option.
|
|
52602
|
+
* @throws {RequiredError}
|
|
52603
|
+
*/
|
|
52604
|
+
v1AdminExperimentsIdResultsGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperimentResults>>;
|
|
52605
|
+
/**
|
|
52606
|
+
* Transitions a draft or paused experiment to running status.
|
|
52607
|
+
* @summary Start an experiment
|
|
52608
|
+
* @param {string} id Experiment ID (slug)
|
|
52609
|
+
* @param {*} [options] Override http request option.
|
|
52610
|
+
* @throws {RequiredError}
|
|
52611
|
+
*/
|
|
52612
|
+
v1AdminExperimentsIdStartPost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
52613
|
+
/**
|
|
52614
|
+
* Creates a new A/B test experiment in draft status.
|
|
52615
|
+
* @summary Create a new experiment
|
|
52616
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
52617
|
+
* @param {*} [options] Override http request option.
|
|
52618
|
+
* @throws {RequiredError}
|
|
52619
|
+
*/
|
|
52620
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperiment>>;
|
|
52621
|
+
};
|
|
52622
|
+
/**
|
|
52623
|
+
* ExperimentsApi - factory interface
|
|
52624
|
+
* @export
|
|
52625
|
+
*/
|
|
52626
|
+
export declare const ExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
52627
|
+
/**
|
|
52628
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
52629
|
+
* @summary List all experiments
|
|
52630
|
+
* @param {*} [options] Override http request option.
|
|
52631
|
+
* @throws {RequiredError}
|
|
52632
|
+
*/
|
|
52633
|
+
v1AdminExperimentsGet(options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
52634
|
+
[key: string]: Array<DataTypesExperiment>;
|
|
52635
|
+
}>;
|
|
52636
|
+
/**
|
|
52637
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
52638
|
+
* @summary Complete an experiment
|
|
52639
|
+
* @param {string} id Experiment ID (slug)
|
|
52640
|
+
* @param {object} [body] Optional winner variant ID
|
|
52641
|
+
* @param {*} [options] Override http request option.
|
|
52642
|
+
* @throws {RequiredError}
|
|
52643
|
+
*/
|
|
52644
|
+
v1AdminExperimentsIdCompletePost(id: string, body?: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
52645
|
+
/**
|
|
52646
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
52647
|
+
* @summary Delete a draft experiment
|
|
52648
|
+
* @param {string} id Experiment ID (slug)
|
|
52649
|
+
* @param {*} [options] Override http request option.
|
|
52650
|
+
* @throws {RequiredError}
|
|
52651
|
+
*/
|
|
52652
|
+
v1AdminExperimentsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
52653
|
+
/**
|
|
52654
|
+
* Returns a single experiment by its experiment_id slug.
|
|
52655
|
+
* @summary Get experiment by ID
|
|
52656
|
+
* @param {string} id Experiment ID (slug)
|
|
52657
|
+
* @param {*} [options] Override http request option.
|
|
52658
|
+
* @throws {RequiredError}
|
|
52659
|
+
*/
|
|
52660
|
+
v1AdminExperimentsIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
|
|
52661
|
+
/**
|
|
52662
|
+
* Transitions a running experiment to paused status.
|
|
52663
|
+
* @summary Pause an experiment
|
|
52664
|
+
* @param {string} id Experiment ID (slug)
|
|
52665
|
+
* @param {*} [options] Override http request option.
|
|
52666
|
+
* @throws {RequiredError}
|
|
52667
|
+
*/
|
|
52668
|
+
v1AdminExperimentsIdPausePost(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
52669
|
+
/**
|
|
52670
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
52671
|
+
* @summary Update an experiment
|
|
52672
|
+
* @param {string} id Experiment ID (slug)
|
|
52673
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
52674
|
+
* @param {*} [options] Override http request option.
|
|
52675
|
+
* @throws {RequiredError}
|
|
52676
|
+
*/
|
|
52677
|
+
v1AdminExperimentsIdPut(id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
|
|
52678
|
+
/**
|
|
52679
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
52680
|
+
* @summary Get experiment results
|
|
52681
|
+
* @param {string} id Experiment ID (slug)
|
|
52682
|
+
* @param {*} [options] Override http request option.
|
|
52683
|
+
* @throws {RequiredError}
|
|
52684
|
+
*/
|
|
52685
|
+
v1AdminExperimentsIdResultsGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperimentResults>;
|
|
52686
|
+
/**
|
|
52687
|
+
* Transitions a draft or paused experiment to running status.
|
|
52688
|
+
* @summary Start an experiment
|
|
52689
|
+
* @param {string} id Experiment ID (slug)
|
|
52690
|
+
* @param {*} [options] Override http request option.
|
|
52691
|
+
* @throws {RequiredError}
|
|
52692
|
+
*/
|
|
52693
|
+
v1AdminExperimentsIdStartPost(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
52694
|
+
/**
|
|
52695
|
+
* Creates a new A/B test experiment in draft status.
|
|
52696
|
+
* @summary Create a new experiment
|
|
52697
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
52698
|
+
* @param {*} [options] Override http request option.
|
|
52699
|
+
* @throws {RequiredError}
|
|
52700
|
+
*/
|
|
52701
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperiment>;
|
|
52702
|
+
};
|
|
52703
|
+
/**
|
|
52704
|
+
* ExperimentsApi - object-oriented interface
|
|
52705
|
+
* @export
|
|
52706
|
+
* @class ExperimentsApi
|
|
52707
|
+
* @extends {BaseAPI}
|
|
52708
|
+
*/
|
|
52709
|
+
export declare class ExperimentsApi extends BaseAPI {
|
|
52710
|
+
/**
|
|
52711
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
52712
|
+
* @summary List all experiments
|
|
52713
|
+
* @param {*} [options] Override http request option.
|
|
52714
|
+
* @throws {RequiredError}
|
|
52715
|
+
* @memberof ExperimentsApi
|
|
52716
|
+
*/
|
|
52717
|
+
v1AdminExperimentsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
52718
|
+
[key: string]: DataTypesExperiment[];
|
|
52719
|
+
}, any, {}>>;
|
|
52720
|
+
/**
|
|
52721
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
52722
|
+
* @summary Complete an experiment
|
|
52723
|
+
* @param {string} id Experiment ID (slug)
|
|
52724
|
+
* @param {object} [body] Optional winner variant ID
|
|
52725
|
+
* @param {*} [options] Override http request option.
|
|
52726
|
+
* @throws {RequiredError}
|
|
52727
|
+
* @memberof ExperimentsApi
|
|
52728
|
+
*/
|
|
52729
|
+
v1AdminExperimentsIdCompletePost(id: string, body?: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
52730
|
+
/**
|
|
52731
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
52732
|
+
* @summary Delete a draft experiment
|
|
52733
|
+
* @param {string} id Experiment ID (slug)
|
|
52734
|
+
* @param {*} [options] Override http request option.
|
|
52735
|
+
* @throws {RequiredError}
|
|
52736
|
+
* @memberof ExperimentsApi
|
|
52737
|
+
*/
|
|
52738
|
+
v1AdminExperimentsIdDelete(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
52739
|
+
/**
|
|
52740
|
+
* Returns a single experiment by its experiment_id slug.
|
|
52741
|
+
* @summary Get experiment by ID
|
|
52742
|
+
* @param {string} id Experiment ID (slug)
|
|
52743
|
+
* @param {*} [options] Override http request option.
|
|
52744
|
+
* @throws {RequiredError}
|
|
52745
|
+
* @memberof ExperimentsApi
|
|
52746
|
+
*/
|
|
52747
|
+
v1AdminExperimentsIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
|
|
52748
|
+
/**
|
|
52749
|
+
* Transitions a running experiment to paused status.
|
|
52750
|
+
* @summary Pause an experiment
|
|
52751
|
+
* @param {string} id Experiment ID (slug)
|
|
52752
|
+
* @param {*} [options] Override http request option.
|
|
52753
|
+
* @throws {RequiredError}
|
|
52754
|
+
* @memberof ExperimentsApi
|
|
52755
|
+
*/
|
|
52756
|
+
v1AdminExperimentsIdPausePost(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
52757
|
+
/**
|
|
52758
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
52759
|
+
* @summary Update an experiment
|
|
52760
|
+
* @param {string} id Experiment ID (slug)
|
|
52761
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
52762
|
+
* @param {*} [options] Override http request option.
|
|
52763
|
+
* @throws {RequiredError}
|
|
52764
|
+
* @memberof ExperimentsApi
|
|
52765
|
+
*/
|
|
52766
|
+
v1AdminExperimentsIdPut(id: string, dataTypesUpdateExperimentRequest: DataTypesUpdateExperimentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
|
|
52767
|
+
/**
|
|
52768
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
52769
|
+
* @summary Get experiment results
|
|
52770
|
+
* @param {string} id Experiment ID (slug)
|
|
52771
|
+
* @param {*} [options] Override http request option.
|
|
52772
|
+
* @throws {RequiredError}
|
|
52773
|
+
* @memberof ExperimentsApi
|
|
52774
|
+
*/
|
|
52775
|
+
v1AdminExperimentsIdResultsGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentResults, any, {}>>;
|
|
52776
|
+
/**
|
|
52777
|
+
* Transitions a draft or paused experiment to running status.
|
|
52778
|
+
* @summary Start an experiment
|
|
52779
|
+
* @param {string} id Experiment ID (slug)
|
|
52780
|
+
* @param {*} [options] Override http request option.
|
|
52781
|
+
* @throws {RequiredError}
|
|
52782
|
+
* @memberof ExperimentsApi
|
|
52783
|
+
*/
|
|
52784
|
+
v1AdminExperimentsIdStartPost(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
52785
|
+
/**
|
|
52786
|
+
* Creates a new A/B test experiment in draft status.
|
|
52787
|
+
* @summary Create a new experiment
|
|
52788
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
52789
|
+
* @param {*} [options] Override http request option.
|
|
52790
|
+
* @throws {RequiredError}
|
|
52791
|
+
* @memberof ExperimentsApi
|
|
52792
|
+
*/
|
|
52793
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest: DataTypesCreateExperimentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperiment, any, {}>>;
|
|
52794
|
+
}
|
|
50546
52795
|
/**
|
|
50547
52796
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
50548
52797
|
* @export
|
|
@@ -51050,6 +53299,266 @@ export declare class FeatureLimitsAdminApi extends BaseAPI {
|
|
|
51050
53299
|
*/
|
|
51051
53300
|
adminV1FeatureLimitsResetPost(featureName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
51052
53301
|
}
|
|
53302
|
+
/**
|
|
53303
|
+
* FiltersApi - axios parameter creator
|
|
53304
|
+
* @export
|
|
53305
|
+
*/
|
|
53306
|
+
export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
53307
|
+
/**
|
|
53308
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
53309
|
+
* @summary Admin Search Facet Values
|
|
53310
|
+
* @param {string} xStoreID X-Store ID
|
|
53311
|
+
* @param {string} facetName Facet field name
|
|
53312
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53313
|
+
* @param {*} [options] Override http request option.
|
|
53314
|
+
* @throws {RequiredError}
|
|
53315
|
+
*/
|
|
53316
|
+
adminV1FiltersXStoreIDFacetNameValuesPost: (xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53317
|
+
/**
|
|
53318
|
+
* Get filter values and counts (admin-authenticated version)
|
|
53319
|
+
* @summary Admin Get Filters
|
|
53320
|
+
* @param {string} xStoreID X-Store ID
|
|
53321
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53322
|
+
* @param {*} [options] Override http request option.
|
|
53323
|
+
* @throws {RequiredError}
|
|
53324
|
+
*/
|
|
53325
|
+
adminV1FiltersXStoreIDPost: (xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53326
|
+
/**
|
|
53327
|
+
* Get filter field metadata (admin-authenticated version)
|
|
53328
|
+
* @summary Admin Get Filters Schema
|
|
53329
|
+
* @param {string} xStoreID X-Store ID
|
|
53330
|
+
* @param {*} [options] Override http request option.
|
|
53331
|
+
* @throws {RequiredError}
|
|
53332
|
+
*/
|
|
53333
|
+
adminV1FiltersXStoreIDSchemaGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53334
|
+
/**
|
|
53335
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
53336
|
+
* @summary Search Facet Values
|
|
53337
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53338
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53339
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
53340
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53341
|
+
* @param {*} [options] Override http request option.
|
|
53342
|
+
* @throws {RequiredError}
|
|
53343
|
+
*/
|
|
53344
|
+
v1FiltersFacetNameValuesPost: (xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53345
|
+
/**
|
|
53346
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
53347
|
+
* @summary Get Filters
|
|
53348
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53349
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53350
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53351
|
+
* @param {*} [options] Override http request option.
|
|
53352
|
+
* @throws {RequiredError}
|
|
53353
|
+
*/
|
|
53354
|
+
v1FiltersPost: (xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53355
|
+
/**
|
|
53356
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
53357
|
+
* @summary Get Filters Schema
|
|
53358
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53359
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53360
|
+
* @param {*} [options] Override http request option.
|
|
53361
|
+
* @throws {RequiredError}
|
|
53362
|
+
*/
|
|
53363
|
+
v1FiltersSchemaGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53364
|
+
};
|
|
53365
|
+
/**
|
|
53366
|
+
* FiltersApi - functional programming interface
|
|
53367
|
+
* @export
|
|
53368
|
+
*/
|
|
53369
|
+
export declare const FiltersApiFp: (configuration?: Configuration) => {
|
|
53370
|
+
/**
|
|
53371
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
53372
|
+
* @summary Admin Search Facet Values
|
|
53373
|
+
* @param {string} xStoreID X-Store ID
|
|
53374
|
+
* @param {string} facetName Facet field name
|
|
53375
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53376
|
+
* @param {*} [options] Override http request option.
|
|
53377
|
+
* @throws {RequiredError}
|
|
53378
|
+
*/
|
|
53379
|
+
adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>>;
|
|
53380
|
+
/**
|
|
53381
|
+
* Get filter values and counts (admin-authenticated version)
|
|
53382
|
+
* @summary Admin Get Filters
|
|
53383
|
+
* @param {string} xStoreID X-Store ID
|
|
53384
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53385
|
+
* @param {*} [options] Override http request option.
|
|
53386
|
+
* @throws {RequiredError}
|
|
53387
|
+
*/
|
|
53388
|
+
adminV1FiltersXStoreIDPost(xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersResponseWrapper>>;
|
|
53389
|
+
/**
|
|
53390
|
+
* Get filter field metadata (admin-authenticated version)
|
|
53391
|
+
* @summary Admin Get Filters Schema
|
|
53392
|
+
* @param {string} xStoreID X-Store ID
|
|
53393
|
+
* @param {*} [options] Override http request option.
|
|
53394
|
+
* @throws {RequiredError}
|
|
53395
|
+
*/
|
|
53396
|
+
adminV1FiltersXStoreIDSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersSchemaResponseWrapper>>;
|
|
53397
|
+
/**
|
|
53398
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
53399
|
+
* @summary Search Facet Values
|
|
53400
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53401
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53402
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
53403
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53404
|
+
* @param {*} [options] Override http request option.
|
|
53405
|
+
* @throws {RequiredError}
|
|
53406
|
+
*/
|
|
53407
|
+
v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>>;
|
|
53408
|
+
/**
|
|
53409
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
53410
|
+
* @summary Get Filters
|
|
53411
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53412
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53413
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53414
|
+
* @param {*} [options] Override http request option.
|
|
53415
|
+
* @throws {RequiredError}
|
|
53416
|
+
*/
|
|
53417
|
+
v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersResponseWrapper>>;
|
|
53418
|
+
/**
|
|
53419
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
53420
|
+
* @summary Get Filters Schema
|
|
53421
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53422
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53423
|
+
* @param {*} [options] Override http request option.
|
|
53424
|
+
* @throws {RequiredError}
|
|
53425
|
+
*/
|
|
53426
|
+
v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesFiltersSchemaResponseWrapper>>;
|
|
53427
|
+
};
|
|
53428
|
+
/**
|
|
53429
|
+
* FiltersApi - factory interface
|
|
53430
|
+
* @export
|
|
53431
|
+
*/
|
|
53432
|
+
export declare const FiltersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
53433
|
+
/**
|
|
53434
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
53435
|
+
* @summary Admin Search Facet Values
|
|
53436
|
+
* @param {string} xStoreID X-Store ID
|
|
53437
|
+
* @param {string} facetName Facet field name
|
|
53438
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53439
|
+
* @param {*} [options] Override http request option.
|
|
53440
|
+
* @throws {RequiredError}
|
|
53441
|
+
*/
|
|
53442
|
+
adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
|
|
53443
|
+
/**
|
|
53444
|
+
* Get filter values and counts (admin-authenticated version)
|
|
53445
|
+
* @summary Admin Get Filters
|
|
53446
|
+
* @param {string} xStoreID X-Store ID
|
|
53447
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53448
|
+
* @param {*} [options] Override http request option.
|
|
53449
|
+
* @throws {RequiredError}
|
|
53450
|
+
*/
|
|
53451
|
+
adminV1FiltersXStoreIDPost(xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
|
|
53452
|
+
/**
|
|
53453
|
+
* Get filter field metadata (admin-authenticated version)
|
|
53454
|
+
* @summary Admin Get Filters Schema
|
|
53455
|
+
* @param {string} xStoreID X-Store ID
|
|
53456
|
+
* @param {*} [options] Override http request option.
|
|
53457
|
+
* @throws {RequiredError}
|
|
53458
|
+
*/
|
|
53459
|
+
adminV1FiltersXStoreIDSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersSchemaResponseWrapper>;
|
|
53460
|
+
/**
|
|
53461
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
53462
|
+
* @summary Search Facet Values
|
|
53463
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53464
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53465
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
53466
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53467
|
+
* @param {*} [options] Override http request option.
|
|
53468
|
+
* @throws {RequiredError}
|
|
53469
|
+
*/
|
|
53470
|
+
v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFacetValuesSearchResponseWrapper>;
|
|
53471
|
+
/**
|
|
53472
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
53473
|
+
* @summary Get Filters
|
|
53474
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53475
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53476
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53477
|
+
* @param {*} [options] Override http request option.
|
|
53478
|
+
* @throws {RequiredError}
|
|
53479
|
+
*/
|
|
53480
|
+
v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersResponseWrapper>;
|
|
53481
|
+
/**
|
|
53482
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
53483
|
+
* @summary Get Filters Schema
|
|
53484
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53485
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53486
|
+
* @param {*} [options] Override http request option.
|
|
53487
|
+
* @throws {RequiredError}
|
|
53488
|
+
*/
|
|
53489
|
+
v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesFiltersSchemaResponseWrapper>;
|
|
53490
|
+
};
|
|
53491
|
+
/**
|
|
53492
|
+
* FiltersApi - object-oriented interface
|
|
53493
|
+
* @export
|
|
53494
|
+
* @class FiltersApi
|
|
53495
|
+
* @extends {BaseAPI}
|
|
53496
|
+
*/
|
|
53497
|
+
export declare class FiltersApi extends BaseAPI {
|
|
53498
|
+
/**
|
|
53499
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
53500
|
+
* @summary Admin Search Facet Values
|
|
53501
|
+
* @param {string} xStoreID X-Store ID
|
|
53502
|
+
* @param {string} facetName Facet field name
|
|
53503
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53504
|
+
* @param {*} [options] Override http request option.
|
|
53505
|
+
* @throws {RequiredError}
|
|
53506
|
+
* @memberof FiltersApi
|
|
53507
|
+
*/
|
|
53508
|
+
adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
|
|
53509
|
+
/**
|
|
53510
|
+
* Get filter values and counts (admin-authenticated version)
|
|
53511
|
+
* @summary Admin Get Filters
|
|
53512
|
+
* @param {string} xStoreID X-Store ID
|
|
53513
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53514
|
+
* @param {*} [options] Override http request option.
|
|
53515
|
+
* @throws {RequiredError}
|
|
53516
|
+
* @memberof FiltersApi
|
|
53517
|
+
*/
|
|
53518
|
+
adminV1FiltersXStoreIDPost(xStoreID: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
|
|
53519
|
+
/**
|
|
53520
|
+
* Get filter field metadata (admin-authenticated version)
|
|
53521
|
+
* @summary Admin Get Filters Schema
|
|
53522
|
+
* @param {string} xStoreID X-Store ID
|
|
53523
|
+
* @param {*} [options] Override http request option.
|
|
53524
|
+
* @throws {RequiredError}
|
|
53525
|
+
* @memberof FiltersApi
|
|
53526
|
+
*/
|
|
53527
|
+
adminV1FiltersXStoreIDSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersSchemaResponseWrapper, any, {}>>;
|
|
53528
|
+
/**
|
|
53529
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
53530
|
+
* @summary Search Facet Values
|
|
53531
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53532
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53533
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
53534
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
53535
|
+
* @param {*} [options] Override http request option.
|
|
53536
|
+
* @throws {RequiredError}
|
|
53537
|
+
* @memberof FiltersApi
|
|
53538
|
+
*/
|
|
53539
|
+
v1FiltersFacetNameValuesPost(xStoreid: string, xStoresecret: string, facetName: string, dataTypesFacetValuesSearchRequest: DataTypesFacetValuesSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFacetValuesSearchResponseWrapper, any, {}>>;
|
|
53540
|
+
/**
|
|
53541
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
53542
|
+
* @summary Get Filters
|
|
53543
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53544
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53545
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
53546
|
+
* @param {*} [options] Override http request option.
|
|
53547
|
+
* @throws {RequiredError}
|
|
53548
|
+
* @memberof FiltersApi
|
|
53549
|
+
*/
|
|
53550
|
+
v1FiltersPost(xStoreid: string, xStoresecret: string, dataTypesFiltersRequest?: DataTypesFiltersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersResponseWrapper, any, {}>>;
|
|
53551
|
+
/**
|
|
53552
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
53553
|
+
* @summary Get Filters Schema
|
|
53554
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
53555
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
53556
|
+
* @param {*} [options] Override http request option.
|
|
53557
|
+
* @throws {RequiredError}
|
|
53558
|
+
* @memberof FiltersApi
|
|
53559
|
+
*/
|
|
53560
|
+
v1FiltersSchemaGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesFiltersSchemaResponseWrapper, any, {}>>;
|
|
53561
|
+
}
|
|
51053
53562
|
/**
|
|
51054
53563
|
* ItemAnalyticsApi - axios parameter creator
|
|
51055
53564
|
* @export
|
|
@@ -59473,6 +61982,17 @@ export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configur
|
|
|
59473
61982
|
* @throws {RequiredError}
|
|
59474
61983
|
*/
|
|
59475
61984
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61985
|
+
/**
|
|
61986
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
61987
|
+
* @summary Get a document by ID
|
|
61988
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
61989
|
+
* @param {string} xStoresecret Store read secret
|
|
61990
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
61991
|
+
* @param {string} documentID Document ID to retrieve
|
|
61992
|
+
* @param {*} [options] Override http request option.
|
|
61993
|
+
* @throws {RequiredError}
|
|
61994
|
+
*/
|
|
61995
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59476
61996
|
/**
|
|
59477
61997
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
59478
61998
|
* @summary Index a single document
|
|
@@ -59512,6 +62032,17 @@ export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
59512
62032
|
* @throws {RequiredError}
|
|
59513
62033
|
*/
|
|
59514
62034
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
62035
|
+
/**
|
|
62036
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
62037
|
+
* @summary Get a document by ID
|
|
62038
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
62039
|
+
* @param {string} xStoresecret Store read secret
|
|
62040
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62041
|
+
* @param {string} documentID Document ID to retrieve
|
|
62042
|
+
* @param {*} [options] Override http request option.
|
|
62043
|
+
* @throws {RequiredError}
|
|
62044
|
+
*/
|
|
62045
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
59515
62046
|
/**
|
|
59516
62047
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
59517
62048
|
* @summary Index a single document
|
|
@@ -59551,6 +62082,17 @@ export declare const SDKDocumentsApiFactory: (configuration?: Configuration, bas
|
|
|
59551
62082
|
* @throws {RequiredError}
|
|
59552
62083
|
*/
|
|
59553
62084
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
62085
|
+
/**
|
|
62086
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
62087
|
+
* @summary Get a document by ID
|
|
62088
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
62089
|
+
* @param {string} xStoresecret Store read secret
|
|
62090
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62091
|
+
* @param {string} documentID Document ID to retrieve
|
|
62092
|
+
* @param {*} [options] Override http request option.
|
|
62093
|
+
* @throws {RequiredError}
|
|
62094
|
+
*/
|
|
62095
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
59554
62096
|
/**
|
|
59555
62097
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
59556
62098
|
* @summary Index a single document
|
|
@@ -59594,6 +62136,18 @@ export declare class SDKDocumentsApi extends BaseAPI {
|
|
|
59594
62136
|
* @memberof SDKDocumentsApi
|
|
59595
62137
|
*/
|
|
59596
62138
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
62139
|
+
/**
|
|
62140
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
62141
|
+
* @summary Get a document by ID
|
|
62142
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
62143
|
+
* @param {string} xStoresecret Store read secret
|
|
62144
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
62145
|
+
* @param {string} documentID Document ID to retrieve
|
|
62146
|
+
* @param {*} [options] Override http request option.
|
|
62147
|
+
* @throws {RequiredError}
|
|
62148
|
+
* @memberof SDKDocumentsApi
|
|
62149
|
+
*/
|
|
62150
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
59597
62151
|
/**
|
|
59598
62152
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
59599
62153
|
* @summary Index a single document
|
|
@@ -59607,6 +62161,77 @@ export declare class SDKDocumentsApi extends BaseAPI {
|
|
|
59607
62161
|
*/
|
|
59608
62162
|
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
59609
62163
|
}
|
|
62164
|
+
/**
|
|
62165
|
+
* SDKExperimentsApi - axios parameter creator
|
|
62166
|
+
* @export
|
|
62167
|
+
*/
|
|
62168
|
+
export declare const SDKExperimentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
62169
|
+
/**
|
|
62170
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
62171
|
+
* @summary Get experiment assignments for a user
|
|
62172
|
+
* @param {string} xStoreid Store ID
|
|
62173
|
+
* @param {string} xStoresecret Store read secret
|
|
62174
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
62175
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
62176
|
+
* @param {*} [options] Override http request option.
|
|
62177
|
+
* @throws {RequiredError}
|
|
62178
|
+
*/
|
|
62179
|
+
v1ExperimentsAssignmentGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62180
|
+
};
|
|
62181
|
+
/**
|
|
62182
|
+
* SDKExperimentsApi - functional programming interface
|
|
62183
|
+
* @export
|
|
62184
|
+
*/
|
|
62185
|
+
export declare const SDKExperimentsApiFp: (configuration?: Configuration) => {
|
|
62186
|
+
/**
|
|
62187
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
62188
|
+
* @summary Get experiment assignments for a user
|
|
62189
|
+
* @param {string} xStoreid Store ID
|
|
62190
|
+
* @param {string} xStoresecret Store read secret
|
|
62191
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
62192
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
62193
|
+
* @param {*} [options] Override http request option.
|
|
62194
|
+
* @throws {RequiredError}
|
|
62195
|
+
*/
|
|
62196
|
+
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesExperimentAssignmentResponse>>;
|
|
62197
|
+
};
|
|
62198
|
+
/**
|
|
62199
|
+
* SDKExperimentsApi - factory interface
|
|
62200
|
+
* @export
|
|
62201
|
+
*/
|
|
62202
|
+
export declare const SDKExperimentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
62203
|
+
/**
|
|
62204
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
62205
|
+
* @summary Get experiment assignments for a user
|
|
62206
|
+
* @param {string} xStoreid Store ID
|
|
62207
|
+
* @param {string} xStoresecret Store read secret
|
|
62208
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
62209
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
62210
|
+
* @param {*} [options] Override http request option.
|
|
62211
|
+
* @throws {RequiredError}
|
|
62212
|
+
*/
|
|
62213
|
+
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesExperimentAssignmentResponse>;
|
|
62214
|
+
};
|
|
62215
|
+
/**
|
|
62216
|
+
* SDKExperimentsApi - object-oriented interface
|
|
62217
|
+
* @export
|
|
62218
|
+
* @class SDKExperimentsApi
|
|
62219
|
+
* @extends {BaseAPI}
|
|
62220
|
+
*/
|
|
62221
|
+
export declare class SDKExperimentsApi extends BaseAPI {
|
|
62222
|
+
/**
|
|
62223
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
62224
|
+
* @summary Get experiment assignments for a user
|
|
62225
|
+
* @param {string} xStoreid Store ID
|
|
62226
|
+
* @param {string} xStoresecret Store read secret
|
|
62227
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
62228
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
62229
|
+
* @param {*} [options] Override http request option.
|
|
62230
|
+
* @throws {RequiredError}
|
|
62231
|
+
* @memberof SDKExperimentsApi
|
|
62232
|
+
*/
|
|
62233
|
+
v1ExperimentsAssignmentGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesExperimentAssignmentResponse, any, {}>>;
|
|
62234
|
+
}
|
|
59610
62235
|
/**
|
|
59611
62236
|
* SDKQuerySuggestionsConfigApi - axios parameter creator
|
|
59612
62237
|
* @export
|
|
@@ -61736,7 +64361,7 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
61736
64361
|
*/
|
|
61737
64362
|
adminStoresXStoreIDAnalyticsTimeseriesGet: (xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61738
64363
|
/**
|
|
61739
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
64364
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
61740
64365
|
* @summary Get Specific API Usage Event
|
|
61741
64366
|
* @param {string} xStoreID Store ID
|
|
61742
64367
|
* @param {string} eventID Event ID (UUID)
|
|
@@ -61964,7 +64589,7 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
|
|
|
61964
64589
|
*/
|
|
61965
64590
|
adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreRouteTimeSeriesResponse>>;
|
|
61966
64591
|
/**
|
|
61967
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
64592
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
61968
64593
|
* @summary Get Specific API Usage Event
|
|
61969
64594
|
* @param {string} xStoreID Store ID
|
|
61970
64595
|
* @param {string} eventID Event ID (UUID)
|
|
@@ -62192,7 +64817,7 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
|
|
|
62192
64817
|
*/
|
|
62193
64818
|
adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<StoreRouteTimeSeriesResponse>;
|
|
62194
64819
|
/**
|
|
62195
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
64820
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
62196
64821
|
* @summary Get Specific API Usage Event
|
|
62197
64822
|
* @param {string} xStoreID Store ID
|
|
62198
64823
|
* @param {string} eventID Event ID (UUID)
|
|
@@ -62433,7 +65058,7 @@ export declare class StoresApi extends BaseAPI {
|
|
|
62433
65058
|
*/
|
|
62434
65059
|
adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID: string, metric: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreRouteTimeSeriesResponse, any, {}>>;
|
|
62435
65060
|
/**
|
|
62436
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
65061
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
62437
65062
|
* @summary Get Specific API Usage Event
|
|
62438
65063
|
* @param {string} xStoreID Store ID
|
|
62439
65064
|
* @param {string} eventID Event ID (UUID)
|