-
Notifications
You must be signed in to change notification settings - Fork 2
/
api2.yaml
1506 lines (1506 loc) · 48.3 KB
/
api2.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
version: '1.0'
title: Taplytics API Reference
description: 'TODO: Add a description'
license:
name: MIT
url: 'http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT'
host: api.taplytics.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/v2/users:
get:
description: ''
summary: List all Users
tags:
- Users
operationId: List all Users
produces:
- application/json
parameters:
- name: page
in: query
required: false
type: integer
format: int32
description: The page number used for pagination
- name: per_page
in: query
required: false
type: integer
format: int32
description: >-
An optional parameter to define the number of results you would like
returned
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/ListAllUsersResponse'
examples:
application/json:
- id: 548223f2c7036020742ff21c
created_at: 2015-01-06T03:51:57.000Z
user_id: 42
email: jonathan@taplytics.com
first_name: Jonathan
last_name: Norris
name: Jonathan Taylor Thomas Norris
metadata:
occupation: Bug Fixer
favourite_color: Chartreuse
favourite movie: You Don't Mess With The Zohan
last_seen_ip: 123.123.123.123
location:
city_name: San Francisco
continent_code: NA
country_code: USA
country_name: United States
latitude: 37.77493
longitude: -122.41942
postal_code: null
region_name: San Francisco
timezone: Europe/San Francisco
experiments:
- experiment_id: 548223f2c7036020742aa21c
variation: 548223f2c7036020742ff21a
devices:
- {}
session_count: 16
x-unitTests:
- request:
method: GET
uri: /v2/users?page=1&per_page=100
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
body: >-
[{ "id": "548223f2c7036020742ff21c", "created_at":
"2015-01-06T03:51:57+00:00", "user_id": "42", "email":
"jonathan@taplytics.com", "first_name": "Jonathan",
"last_name": "Norris", "name": "Jonathan Taylor Thomas
Norris", "metadata": { "occupation": "Bug Fixer",
"favourite_color": "Chartreuse", "favourite movie": "You
Don't Mess With The Zohan" }, "last_seen_ip":
"123.123.123.123", "location": { "city_name": "San
Francisco", "continent_code": "NA", "country_code":
"USA", "country_name": "United States", "latitude":
37.7749300, "longitude": -122.4194200,
"postal_code": null, "region_name": "San Francisco",
"timezone": "Europe/San Francisco" }, "experiments":
[{ "experiment_id": "548223f2c7036020742aa21c",
"variation": "548223f2c7036020742ff21a" }], "devices": [{
}], "session_count": 16}]
x-testShouldPass: true
x-testEnabled: true
x-testName: List all Users1
x-testDescription: Testcase for testing endpoint List all Users
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
'/v2/users/{id}':
get:
description: >-
A single User object with all its details, accessed via either ID, email
or your custom user ID. If an email or custom ID is provided in the URL
parameters, the ID field can be omitted. Note that custom data can only
be reliably kept with no more than one level of nesting. If the user
currently has a custom data object and one is posted, the two will be
merged.
summary: Retrieve a User
tags:
- Users
operationId: Retrieve a User
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
description: String `id` of the User to retrieve.
- name: user_id
in: query
required: false
type: string
description: Your custom defined user id.
- name: email
in: query
required: false
type: string
description: Your custom defined user email
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RetrieveAUserResponse'
examples:
application/json:
id: 548223f2c7036020742ff21c
created_at: 2015-01-06T03:51:57.000Z
user_id: 42
email: jonathan@taplytics.com
first_name: Jonathan
last_name: Norris
custom_data:
occupation: Bug Fixer
favourite_color: Chartreuse
favourite movie: You Don't Mess With The Zohan
last_seen_ip: 123.123.123.123
location:
city_name: San Francisco
continent_code: NA
country_code: USA
country_name: United States
latitude: 37.77493
longitude: -122.41942
postal_code: null
region_name: San Francisco
timezone: Europe/San Francisco
session_count: 16
gender: male
x-unitTests:
- request:
method: GET
uri: >-
/v2/users/548223f2c7036020742ff21c?user_id=42&email=jonathan@taplytics.com
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
body: >-
{ "id": "548223f2c7036020742ff21c", "created_at":
"2015-01-06T03:51:57+00:00", "user_id": "42", "email":
"jonathan@taplytics.com", "first_name": "Jonathan",
"last_name": "Norris", "custom_data": { "occupation":
"Bug Fixer", "favourite_color": "Chartreuse",
"favourite movie": "You Don't Mess With The Zohan" },
"last_seen_ip": "123.123.123.123", "location": {
"city_name": "San Francisco", "continent_code":
"NA", "country_code": "USA", "country_name": "United
States", "latitude": 37.7749300, "longitude":
-122.4194200, "postal_code": null, "region_name":
"San Francisco", "timezone": "Europe/San Francisco"
}, "session_count": 16, "gender": "male"}
x-testShouldPass: true
x-testEnabled: true
x-testName: Retrieve a User1
x-testDescription: >-
A single User object with all its details, accessed via either ID,
email or your custom user ID. If an email or custom ID is provided
in the URL parameters, the ID field can be omitted. Note that custom
data can only be reliably kept with no more than one level of
nesting. If the user currently has a custom data object and one is
posted, the two will be merged.
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
post:
description: >-
A single User object with all its details, accessed via either ID, email
or your custom user ID. If an email or custom ID is provided in the URL
parameters, the ID field can be omitted. Note that custom data can only
be reliably kept with no more than one level of nesting. If the user
currently has a custom data object and one is posted, the two will be
merged.
summary: Create or Update a User
tags:
- Users
operationId: Create or Update a User
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
description: String `id` of the User to retrieve.
- name: body
in: body
required: true
description: ''
schema:
$ref: '#/definitions/CreateOrUpdateAUserRequest'
- name: user_id
in: query
required: false
type: string
description: Your custom defined user id.
- name: email
in: query
required: false
type: string
description: Your custom defined user email
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CreateOrUpdateAUserResponse'
examples:
application/json:
id: 548223f2c7036020742ff21c
created_at: 2015-01-06T03:51:57.000Z
user_id: 42
email: jonathan@taplytics.com
first_name: Jonathan
last_name: Norris
custom_data:
occupation: Bug Fixer
favourite_color: Chartreuse
favourite movie: You Don't Mess With The Zohan
last_seen_ip: 123.123.123.123
location:
city_name: San Francisco
continent_code: NA
country_code: USA
country_name: United States
latitude: 37.77493
longitude: -122.41942
postal_code: null
region_name: San Francisco
timezone: Europe/San Francisco
session_count: 16
gender: male
x-unitTests:
- request:
method: POST
uri: >-
/v2/users/548223f2c7036020742ff21c?user_id=42&email=jonathan@taplytics.com
headers:
Content-Type: application/json
body: >-
{ "gender": "male", "first_name": "Jonathan",
"last_name": "Norris", "user_id": "42", "custom_data":
{ "occupation": "Bug Fixer", "favourite movie": "You
Don't Mess With The Zohan" }, "email":
"jonathan@taplytics.com"}
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
body: >-
{ "id": "548223f2c7036020742ff21c", "created_at":
"2015-01-06T03:51:57+00:00", "user_id": "42", "email":
"jonathan@taplytics.com", "first_name": "Jonathan",
"last_name": "Norris", "custom_data": { "occupation":
"Bug Fixer", "favourite_color": "Chartreuse",
"favourite movie": "You Don't Mess With The Zohan" },
"last_seen_ip": "123.123.123.123", "location": {
"city_name": "San Francisco", "continent_code":
"NA", "country_code": "USA", "country_name": "United
States", "latitude": 37.7749300, "longitude":
-122.4194200, "postal_code": null, "region_name":
"San Francisco", "timezone": "Europe/San Francisco"
}, "session_count": 16, "gender": "male"}
x-testShouldPass: true
x-testEnabled: true
x-testName: Create or Update a User1
x-testDescription: >-
A single User object with all its details, accessed via either ID,
email or your custom user ID. If an email or custom ID is provided
in the URL parameters, the ID field can be omitted. Note that custom
data can only be reliably kept with no more than one level of
nesting. If the user currently has a custom data object and one is
posted, the two will be merged.
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
delete:
description: >-
A single User object with all its details, accessed via either ID, email
or your custom user ID. If an email or custom ID is provided in the URL
parameters, the ID field can be omitted. Note that custom data can only
be reliably kept with no more than one level of nesting. If the user
currently has a custom data object and one is posted, the two will be
merged.
summary: Remove a User
tags:
- Users
operationId: Remove a User
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
description: String `id` of the User to retrieve.
- name: user_id
in: query
required: false
type: string
description: Your custom defined user id.
- name: email
in: query
required: false
type: string
description: Your custom defined user email +
responses:
'200':
description: ''
x-unitTests:
- request:
method: DELETE
uri: >-
/v2/users/548223f2c7036020742ff21c?user_id=42&email=jonathan@taplytics.com
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: NONE
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
x-testShouldPass: true
x-testEnabled: true
x-testName: Remove a User1
x-testDescription: >-
A single User object with all its details, accessed via either ID,
email or your custom user ID. If an email or custom ID is provided
in the URL parameters, the ID field can be omitted. Note that custom
data can only be reliably kept with no more than one level of
nesting. If the user currently has a custom data object and one is
posted, the two will be merged.
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
/v2/experiments:
get:
description: ''
summary: List all Experiments
tags:
- Experiments
operationId: List all Experiments
produces:
- application/json
parameters:
- name: page
in: query
required: false
type: integer
format: int32
description: The page number used for pagination
- name: per_page
in: query
required: false
type: integer
format: int32
description: >-
An optional parameter to define the number of results you would like
returned
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/ListAllExperimentsResponse'
examples:
application/json:
- id: 548223f2c7036020742ff21c
created_at: 2015-01-06T03:51:57.000Z
user_id: 42
email: jonathan@taplytics.com
first_name: Jonathan
last_name: Norris
name: Jonathan Taylor Thomas Norris
metadata:
occupation: Bug Fixer
favourite_color: Chartreuse
favourite movie: You Don't Mess With The Zohan
last_seen_ip: 123.123.123.123
location:
city_name: San Francisco
continent_code: NA
country_code: USA
country_name: United States
latitude: 37.77493
longitude: -122.41942
postal_code: null
region_name: San Francisco
timezone: Europe/San Francisco
experiments:
- experiment_id: 548223f2c7036020742aa21c
variation: 548223f2c7036020742ff21a
devices:
- {}
session_count: 16
x-unitTests:
- request:
method: GET
uri: /v2/experiments?page=1&per_page=100
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
body: >-
[{ "id": "548223f2c7036020742ff21c", "created_at":
"2015-01-06T03:51:57+00:00", "user_id": "42", "email":
"jonathan@taplytics.com", "first_name": "Jonathan",
"last_name": "Norris", "name": "Jonathan Taylor Thomas
Norris", "metadata": { "occupation": "Bug Fixer",
"favourite_color": "Chartreuse", "favourite movie": "You
Don't Mess With The Zohan" }, "last_seen_ip":
"123.123.123.123", "location": { "city_name": "San
Francisco", "continent_code": "NA", "country_code":
"USA", "country_name": "United States", "latitude":
37.7749300, "longitude": -122.4194200,
"postal_code": null, "region_name": "San Francisco",
"timezone": "Europe/San Francisco" }, "experiments":
[{ "experiment_id": "548223f2c7036020742aa21c",
"variation": "548223f2c7036020742ff21a" }], "devices": [{
}], "session_count": 16}]
x-testShouldPass: true
x-testEnabled: true
x-testName: List all Experiments1
x-testDescription: Testcase for testing endpoint List all Experiments
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
'/v2/experiments/{id}':
get:
description: A single Experiment object with all its details
summary: Retrieve an Experiment
tags:
- Experiments
operationId: Retrieve an Experiment
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
description: String `id` of the Experiment to retrieve.
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RetrieveAnExperimentResponse'
examples:
application/json:
id: 548223f2c7036020742ff21c
project_id: 52718670ef1a872530000022
variations:
- 548223f2c7036020742ff21c
- 512263f2c79g607s142gf21h
winning_variation: 548223f2c7036020742ff21c
baseline_variation: 548223f2c7036020742ff21c
goal_ids:
- 54ac360cc4d37a81567a72e7
status: active
description: Disables the Buy button
min_app_version: 1
max_app_version: 1.8.4
filters:
version: 1.2.3
os_version: 4.4.4
created_at: 2015-01-06T03:51:57.000Z
updated_at: 2015-01-06T03:51:57.000Z
x-unitTests:
- request:
method: GET
uri: /v2/experiments/548223f2c7036020742ff21c
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
body: >-
{ "id": "548223f2c7036020742ff21c", "project_id":
"52718670ef1a872530000022", "variations": [
"548223f2c7036020742ff21c", "512263f2c79g607s142gf21h"
], "winning_variation": "548223f2c7036020742ff21c",
"baseline_variation": "548223f2c7036020742ff21c", "goal_ids":
["54ac360cc4d37a81567a72e7"], "status": "active",
"description": "Disables the Buy button", "min_app_version":
"1.0", "max_app_version": "1.8.4", "filters": {
"version": "1.2.3", "os_version": "4.4.4" },
"created_at": "2015-01-06T03:51:57+00:00", "updated_at":
"2015-01-06T03:51:57+00:00"}
x-testShouldPass: true
x-testEnabled: true
x-testName: Retrieve an Experiment1
x-testDescription: A single Experiment object with all its details
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
delete:
description: A single Experiment object with all its details
summary: Remove an Experiment
tags:
- Experiments
operationId: Remove an Experiment
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
description: Taplytics id of the experiment you would like to delete.
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RemoveAnExperimentResponse'
examples:
application/json:
deleted: true
id: 548223f2c7036020742ff21c
x-unitTests:
- request:
method: DELETE
uri: /v2/experiments/548223f2c7036020742ff21c
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json; charset=utf-8
body: '{ "deleted": true, "id": "548223f2c7036020742ff21c"}'
x-testShouldPass: true
x-testEnabled: true
x-testName: Remove an Experiment1
x-testDescription: A single Experiment object with all its details
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
/v2/events:
post:
description: >-
Post a list of new events to the server. Must provide a session_id with
the request, and each event must have a name. No more than 100 events
can be sent in a single request body.
summary: Create New Events
tags:
- Events
operationId: Create New Events
produces:
- application/json
parameters:
- name: session_id
in: query
required: true
type: string
description: >-
Taplytics id of the current user session you wish to send an event
for
- name: body
in: body
required: true
description: ''
schema:
type: array
items:
$ref: '#/definitions/CreateNewEventsRequest'
responses:
'200':
description: ''
x-unitTests:
- request:
method: POST
uri: /v2/events?session_id=548223f2c7036020742ff21c
headers:
Content-Type: application/json
body: >-
[{ "name": "Purchase", "date":
"2015-01-06T03:50:57+00:00", "value": 42, "metaData":
{ "occupation": "Bug Fixer", "favourite movie": "You
Don't Mess With The Zohan" },}]
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: NONE
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers: {}
x-testShouldPass: true
x-testEnabled: true
x-testName: Create New Events1
x-testDescription: >-
Post a list of new events to the server. Must provide a session_id
with the request, and each event must have a name. No more than 100
events can be sent in a single request body.
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
/v2/push:
get:
description: >-
The default endpoint to send a single push notification, or a batch of
notifications.
summary: List all Push Notifications
tags:
- Push Notifications
operationId: List all Push Notifications
produces:
- application/json
parameters:
- name: page
in: query
required: false
type: integer
format: int32
description: The page number used for pagination
- name: per_page
in: query
required: false
type: integer
format: int32
description: >-
An optional parameter to define the number of results you would like
returned
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/ListAllPushNotificationsResponse'
examples:
application/json:
- id: 548013f2c703f020242ff21c
filters:
- type: an_version
comparator: '>='
values:
- 5.0.0
- type: ios_version
comparator: '!='
values:
- 8.0.1
- type: country
comparator: =
values:
- Canada
- US
- type: custom_data
comparator: '>='
values:
- 16
dataKey: dollars spent
notification:
alert: 'Congratulations, you''ve won a new VCR!'
production: false
x-unitTests:
- request:
method: GET
uri: /v2/push?page=1&per_page=100
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json
body: >-
[{ "id": "548013f2c703f020242ff21c", "filters": [{
"type": "an_version", "comparator": ">=", "values":
["5.0.0"] }, { "type": "ios_version",
"comparator": "!=", "values": ["8.0.1"] }, {
"type": "country", "comparator": "=", "values":
["Canada", "US"] }, { "type": "custom_data",
"comparator": ">=", "values": [16], "dataKey":
"dollars spent" }], "notification": { "alert":
"Congratulations, you've won a new VCR!" }, "production":
false}]
x-testShouldPass: true
x-testEnabled: true
x-testName: List all Push Notifications1
x-testDescription: >-
The default endpoint to send a single push notification, or a batch
of notifications.
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
post:
description: >-
The default endpoint to send a single push notification, or a batch of
notifications.
summary: Send a New Push Notification
tags:
- Push Notifications
operationId: Send a New Push Notification
produces:
- application/json
parameters:
- name: body
in: body
required: true
description: ''
schema:
$ref: '#/definitions/SendANewPushNotificationRequest'
- name: per_page
in: query
required: false
type: string
description: ''
- name: page
in: query
required: false
type: string
description: ''
responses:
'200':
description: ''
schema:
type: object
examples: {}
x-unitTests: []
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
'/v2/push/{id}':
get:
description: The default endpoint to retrieve a single push notification
summary: Retrieve a Push Notification
tags:
- Push Notifications
operationId: Retrieve a Push Notification
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
description: ''
responses:
'200':
description: ''
schema:
$ref: '#/definitions/RetrieveAPushNotificationResponse'
examples:
application/json:
id: 548013f2c703f020242ff21c
filters:
- type: an_version
comparator: '>='
values:
- 5.0.0
- type: ios_version
comparator: '!='
values:
- 8.0.1
- type: country
comparator: =
values:
- Canada
- US
- type: custom_data
comparator: '>='
values:
- 16
dataKey: dollars spent
notification:
alert: 'Congratulations, you''ve won a new VCR!'
production: false
x-unitTests:
- request:
method: GET
uri: '/v2/push/{id}'
expectedResponse:
x-allowExtraHeaders: true
x-bodyMatchMode: RAW
x-arrayOrderedMatching: false
x-arrayCheckCount: false
x-matchResponseSchema: true
headers:
Content-Type: application/json
body: >-
{ "id": "548013f2c703f020242ff21c", "filters": [{
"type": "an_version", "comparator": ">=", "values":
["5.0.0"] }, { "type": "ios_version",
"comparator": "!=", "values": ["8.0.1"] }, {
"type": "country", "comparator": "=", "values":
["Canada", "US"] }, { "type": "custom_data",
"comparator": ">=", "values": [16], "dataKey":
"dollars spent" }], "notification": { "alert":
"Congratulations, you've won a new VCR!" }, "production":
false}
x-testShouldPass: true
x-testEnabled: true
x-testName: Retrieve a Push Notification1
x-testDescription: The default endpoint to retrieve a single push notification
x-operation-settings:
CollectParameters: false
AllowDynamicQueryParameters: false
AllowDynamicFormParameters: false
IsMultiContentStreaming: false
definitions:
ListAllUsersResponse:
title: List all Users response
example:
id: 548223f2c7036020742ff21c
created_at: 2015-01-06T03:51:57.000Z
user_id: 42
email: jonathan@taplytics.com
first_name: Jonathan
last_name: Norris
name: Jonathan Taylor Thomas Norris
metadata:
occupation: Bug Fixer
favourite_color: Chartreuse
favourite movie: You Don't Mess With The Zohan
last_seen_ip: 123.123.123.123
location:
city_name: San Francisco
continent_code: NA
country_code: USA
country_name: United States
latitude: 37.77493
longitude: -122.41942
postal_code: null
region_name: San Francisco
timezone: Europe/San Francisco
experiments:
- experiment_id: 548223f2c7036020742aa21c
variation: 548223f2c7036020742ff21a
devices:
- {}
session_count: 16
type: object
properties:
id:
description: ''
type: string
created_at:
description: ''
type: string
user_id:
description: ''
type: string
email:
description: ''
type: string
first_name:
description: ''
type: string
last_name:
description: ''
type: string
name:
description: ''
type: string
metadata:
description: ''
type: object
last_seen_ip:
description: ''
type: string
location:
description: ''
type: object
experiments:
description: ''
type: array
items:
type: object
devices:
description: ''
type: array
items:
type: object
session_count:
description: ''
type: integer
format: int32
required:
- id
- created_at
- user_id
- email
- first_name
- last_name
- name
- metadata
- last_seen_ip
- location
- experiments
- devices
- session_count
RetrieveAUserResponse:
title: Retrieve a User response
example:
id: 548223f2c7036020742ff21c
created_at: 2015-01-06T03:51:57.000Z
user_id: 42
email: jonathan@taplytics.com
first_name: Jonathan
last_name: Norris
custom_data:
occupation: Bug Fixer
favourite_color: Chartreuse
favourite movie: You Don't Mess With The Zohan
last_seen_ip: 123.123.123.123
location:
city_name: San Francisco
continent_code: NA
country_code: USA
country_name: United States
latitude: 37.77493
longitude: -122.41942
postal_code: null
region_name: San Francisco
timezone: Europe/San Francisco
session_count: 16
gender: male
type: object