forked from exceptionless/Exceptionless
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapiary.apib
More file actions
2817 lines (2537 loc) · 97.4 KB
/
apiary.apib
File metadata and controls
2817 lines (2537 loc) · 97.4 KB
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
FORMAT: 1A
HOST: http://api.exceptionless.io/api/v2
# Exceptionless
Discover errors in your .NET app you never knew were happening and use detailed error reports to squash them with ease. Make your app Exceptionless!
# Group Events
Event related resources of the **Events API**
## Create [/events]
You can create an event by posting any uncompressed or compressed (`gzip` or `deflate`) string or json object.
### Create new event [POST]
You can post any JSON object to create an event. If we know how to handle it we will create a new event. If none of the JSON properties match the `event` object then we will create a new event and place your JSON object into the events data collection.
You can also post a multiline string. We automatically split strings by the `\n` character and create a new log event for every line.
+ Request Event from JSON (application/json)
{ "message": "Exceptionless is amazing!" }
+ Request Multiple events from string content (application/text)
Exceptionless is amazing!
Exceptionless is really amazing!
+ Request Error from JSON (application/json)
{
"type": "error",
"date": "2020-10-16T18:59:09.579Z",
"@simple_error": {
"message": "Simple Exception",
"type": "System.Exception",
"stack_trace": " at Client.Tests.ExceptionlessClientTests.CanSubmitSimpleException() in c:\\Code\\Exceptionless\\Source\\Clients\\Tests\\ExceptionlessClientTests.cs:line 77"
}
}
+ Response 202
## Get [/events/{id}{?filter,time,offset}]
### Get by id [GET]
+ Parameters
+ id (required, string, `537b7255b77efe2474bfdd80`) ... The identifier of the event.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ Response 200 (application/json)
{
"id": "537b7255b77efe2474bfdd80",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"stack_id": "537b7255b77efe2474bfdd7f",
"is_first_occurrence": false,
"is_fixed": false,
"is_hidden": false,
"created_utc": "2020-10-16T18:59:09.579Z",
"type": "log",
"source": null,
"tags": [],
"message": "Exceptionless is amazing!",
"geo": "-88.013,44.529",
"data": {},
"reference_id": null,
"session_id": null
}
## Get all [/events{?filter,sort,time,offset,mode,page,limit}]
### List all events [GET]
+ Parameters
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ sort (optional, string, `-date`) ... Controls the `sort` order that the data is returned in. In this example -date returns the results descending by date.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd80",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"stack_id": "537b7255b77efe2474bfdd7f",
"is_first_occurrence": false,
"is_fixed": false,
"is_hidden": false,
"created_utc": "2020-10-16T18:59:09.579Z",
"type": "log",
"source": null,
"tags": [],
"message": "Exceptionless is amazing!",
"geo": "-88.013,44.529",
"data": {},
"reference_id": null,
"session_id": null
}]
## Get by reference id [/projects/{id}/events/by-ref/{reference_id}]
### List all events for a given reference id [GET]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ reference_id (required, string, `1234567890`) ... An identifier used that references an event instance. The identifier must contain between 8 and 32 characters.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd80",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"stack_id": "537b7255b77efe2474bfdd7f",
"is_first_occurrence": false,
"is_fixed": false,
"is_hidden": false,
"created_utc": "2020-10-16T18:59:09.579Z",
"type": "log",
"source": null,
"tags": [],
"message": "Exceptionless is amazing!",
"geo": "-88.013,44.529",
"data": {},
"reference_id": "1234567890",
"session_id": null
}]
## Get by organization [/organizations/{id}/events{?filter,sort,time,offset,mode,page,limit}]
### List all events for a given organization [GET]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ sort (optional, string, `-date`) ... Controls the `sort` order that the data is returned in. In this example -date returns the results descending by date.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd80",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"stack_id": "537b7255b77efe2474bfdd7f",
"is_first_occurrence": false,
"is_fixed": false,
"is_hidden": false,
"created_utc": "2020-10-16T18:59:09.579Z",
"type": "log",
"source": null,
"tags": [],
"message": "Exceptionless is amazing!",
"geo": "-88.013,44.529",
"data": {},
"reference_id": null,
"session_id": null
}]
## Get by project [/projects/{id}/events{?filter,sort,time,offset,mode,page,limit}]
### List all events for a given project [GET]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ sort (optional, string, `-date`) ... Controls the `sort` order that the data is returned in. In this example -date returns the results descending by date.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd80",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"stack_id": "537b7255b77efe2474bfdd7f",
"is_first_occurrence": false,
"is_fixed": false,
"is_hidden": false,
"created_utc": "2020-10-16T18:59:09.579Z",
"type": "log",
"source": null,
"tags": [],
"message": "Exceptionless is amazing!",
"geo": "-88.013,44.529",
"data": {},
"reference_id": null,
"session_id": null
}]
## Get by stack [/stacks/{id}/events{?filter,sort,time,offset,mode,page,limit}]
### List all events for a given stack [GET]
+ Parameters
+ id (required, string, `537b7255b77efe2474bfdd7f`) ... The identifier of the stack.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ sort (optional, string, `-date`) ... Controls the `sort` order that the data is returned in. In this example -date returns the results descending by date.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd80",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"stack_id": "537b7255b77efe2474bfdd7f",
"is_first_occurrence": false,
"is_fixed": false,
"is_hidden": false,
"created_utc": "2020-10-16T18:59:09.579Z",
"type": "log",
"source": null,
"tags": [],
"message": "Exceptionless is amazing!",
"geo": "-88.013,44.529",
"data": {},
"reference_id": null,
"session_id": null
}]
## Set user description [/projects/{id}/events/by-ref/{reference_id}/user-description]
You can also save an end users contact information and a description of the event. This is really useful for error events as a user can specify reproduction steps in the description.
### Sets the user description for a specific event [POST]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ reference_id (required, string, `1234567890`) ... An identifier used that references an event instance. The identifier must contain between 8 and 32 characters.
+ Request UserDescription from JSON (application/json)
{
"email_address": "noreply@exceptionless.io",
"description": "This product is amazing!"
}
+ Response 202
## Remove [/events/{ids}]
+ Parameters
+ ids (required, string, `537b7255b77efe2474bfdd7f,637b7255b77efe2474bfdd7e`) ... A comma delimited list of event identifiers.
### Remove event occurrences [DELETE]
+ Response 204
# Group Organizations
Organizations related resources of the **Organization API**
## Create [/organizations]
### Create new organization [POST]
+ Request (application/json)
{ "name": "Acme" }
+ Response 201 (application/json)
{
"id": "537650f3b77efe23a47914f3",
"name": "Acme",
"plan_id": "EX_UNLIMITED",
"plan_name": "Unlimited",
"plan_description": "Unlimited",
"card_last4": null,
"subscribe_date": null,
"billing_change_date": "2020-10-16T18:59:09.579Z",
"billing_changed_by_user_id": "53baedfdd424fa1338fc57b4",
"billing_status": 0,
"billing_price": 0.0,
"max_events_per_month": -1,
"bonus_events_per_month": 0,
"bonus_expiration": null,
"retention_days": -1,
"is_suspended": false,
"suspension_code": null,
"suspension_notes": null,
"suspension_date": null,
"has_premium_features": true,
"max_users": -1,
"max_projects": -1,
"project_count": 1,
"stack_count": 2,
"event_count": 62,
"last_event_date": "2020-10-16T19:28:36.165Z",
"invites": [],
"overage_hours": [],
"usage": [],
"data": {},
"is_over_hourly_limit": false,
"is_over_monthly_limit": false
}
## Get, Update [/organizations/{id}]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
### Get by id [GET]
+ Response 200 (application/json)
{
"id": "537650f3b77efe23a47914f3",
"name": "Acme",
"plan_id": "EX_UNLIMITED",
"plan_name": "Unlimited",
"plan_description": "Unlimited",
"card_last4": null,
"subscribe_date": null,
"billing_change_date": "2020-10-16T18:59:09.579Z",
"billing_changed_by_user_id": "53baedfdd424fa1338fc57b4",
"billing_status": 0,
"billing_price": 0.0,
"max_events_per_month": -1,
"bonus_events_per_month": 0,
"bonus_expiration": null,
"retention_days": -1,
"is_suspended": false,
"suspension_code": null,
"suspension_notes": null,
"suspension_date": null,
"has_premium_features": true,
"max_users": -1,
"max_projects": -1,
"project_count": 1,
"stack_count": 2,
"event_count": 62,
"last_event_date": "2020-10-16T19:28:36.165Z",
"invites": [],
"overage_hours": [],
"usage": [],
"data": {},
"is_over_hourly_limit": false,
"is_over_monthly_limit": false
}
### Update organization [PATCH]
+ Request (application/json)
{ "name": "Updated Acme" }
+ Response 200 (application/json)
{
"id": "537650f3b77efe23a47914f3",
"name": "Updated Acme",
"plan_id": "EX_UNLIMITED",
"plan_name": "Unlimited",
"plan_description": "Unlimited",
"card_last4": null,
"subscribe_date": null,
"billing_change_date": "2020-10-16T18:59:09.579Z",
"billing_changed_by_user_id": "53baedfdd424fa1338fc57b4",
"billing_status": 0,
"billing_price": 0.0,
"max_events_per_month": -1,
"bonus_events_per_month": 0,
"bonus_expiration": null,
"retention_days": -1,
"is_suspended": false,
"suspension_code": null,
"suspension_notes": null,
"suspension_date": null,
"has_premium_features": true,
"max_users": -1,
"max_projects": -1,
"project_count": 1,
"stack_count": 2,
"event_count": 62,
"last_event_date": "2020-10-16T19:28:36.165Z",
"invites": [],
"overage_hours": [],
"usage": [],
"data": {},
"is_over_hourly_limit": false,
"is_over_monthly_limit": false
}
## Remove [/organizations/{ids}]
+ Parameters
+ ids (required, string, `537650f3b77efe23a47914f3,637650f3b77efe23a47914fe`) ... A comma delimited list of organization identifiers.
### Remove organizations [DELETE]
+ Response 204
## Get all [/organizations{?page,limit}]
### List all organizations [GET]
+ Parameters
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537650f3b77efe23a47914f3",
"name": "Acme",
"plan_id": "EX_UNLIMITED",
"plan_name": "Unlimited",
"plan_description": "Unlimited",
"card_last4": null,
"subscribe_date": null,
"billing_change_date": "2020-10-16T18:59:09.579Z",
"billing_changed_by_user_id": "53baedfdd424fa1338fc57b4",
"billing_status": 0,
"billing_price": 0.0,
"max_events_per_month": -1,
"bonus_events_per_month": 0,
"bonus_expiration": null,
"retention_days": -1,
"is_suspended": false,
"suspension_code": null,
"suspension_notes": null,
"suspension_date": null,
"has_premium_features": true,
"max_users": -1,
"max_projects": -1,
"project_count": 1,
"stack_count": 2,
"event_count": 62,
"last_event_date": "2020-10-16T19:28:36.165Z",
"invites": [],
"overage_hours": [],
"usage": [],
"data": {},
"is_over_hourly_limit": false,
"is_over_monthly_limit": false
}]
## Get invoice [/organizations/invoice/{id}]
### Get invoice [GET]
Returns a collection of invoices.
+ Parameters
+ id (required, string, `5T6jZsbMu6AI3S`) ... The identifier of the organization.
+ Response 200 (application/json)
{
"id": "5T6jZsbMu6AI3S",
"organization_id": "537650f3b77efe23a47914f3",
"organization_name": "Acme",
"date": "2020-01-01T19:28:36.165Z",
"paid": true,
"total": 499.0,
"items": [
{
"description": "Exceptionless - My Random Plan ($499.00/month)",
"date": "1/1/2020 - 2/1/2020",
"amount": 499.0
}
]
}
## Get invoices [/organizations/{id}/invoices{?before,after,limit}]
### Get invoices [GET]
Returns a collection of invoices.
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ before (optional, string, `537650f3b77efe23a47914f4`) ... A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `before=obj_bar` in order to fetch the previous page of the list.
+ after (optional, string, `537650f3b77efe23a47914f4`) ... A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `after=obj_foo` in order to fetch the next page of the list.
+ limit = `12` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "5T6jZsbMu6AI3S",
"date": "2020-01-01T19:28:36.165Z",
"paid": true
}]
## Change plan [/organizations/{id}/change-plan{?planId,stripeToken,last4}]
### Change plan [GET]
Upgrades or downgrades the organizations plan.
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ planId (required, string, `EX_LARGE`) ... The identifier of the plan.
+ stripeToken (optional, string, `abcdefg`) ... The token returned from the stripe service.
+ last4 (optional, string, `4242`) ... The last four numbers of the card.
+ Response 200 (application/json)
{
"success": true,
"message": ""
}
## Manage users [/organizations/{id}/user/{email}]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ email (required, string, `noreply@exceptionless.io`) ... The email address of the user you wish to remove from your organization.
### Create new user [POST]
+ Response 200 (application/json)
{
"email_address": "noreply@exceptionless.io"
}
### Remove user [DELETE]
+ Response 200
## Add custom data [/organizations/{id}/data/{key}{?value}]
### Add custom data value [POST]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ key (required, string, `zip-code`) ... The key name of the data object.
+ value (required, string, `90210`) ... Any string value.
+ Response 200
## Remove custom data [/organizations/{id}/data/{key}]
### Remove custom data value [DELETE]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ key (required, string, `zip-code`) ... The key name of the data object.
+ Response 200
## Check for unique name [/organizations/check-name/{name}]
### Check for unique organization name [GET]
Returns a `204` status code if an existing orgnaization with the specified name does not exist.
+ Parameters
+ name (required, string, `Acme`) ... The organization name to check.
+ Response 204
`204` status code is returned if the name is available.
+ Body
+ Response 201
`201` status code is returned if the name is not available.
+ Body
# Group Projects
Project related resources of the **Projects API**
## Create [/projects]
### Create new project [POST]
+ Request (application/json)
{
"organization_id": "537650f3b77efe23a47914f3",
"name": "Disintegrating Pistol"
}
+ Response 201 (application/json)
{
"id": "537650f3b77efe23a47914f4",
"organization_id": "537650f3b77efe23a47914f3",
"organization_name": "Acme",
"name": "Disintegrating Pistol",
"delete_bot_data_enabled": true,
"data": {},
"promoted_tabs": [],
"stack_count": 2,
"event_count": 62
}
## Get all [/projects{?page,limit}]
### List all projects [GET]
+ Parameters
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537650f3b77efe23a47914f4",
"organization_id": "537650f3b77efe23a47914f3",
"organization_name": "Acme",
"name": "Disintegrating Pistol",
"delete_bot_data_enabled": true,
"data": {},
"promoted_tabs": [],
"stack_count": 2,
"event_count": 62
}]
## Get by organization [/organizations/{id}/projects{?page,limit}]
### List all projects for a given organization [GET]
+ Parameters
+ id (optional, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537650f3b77efe23a47914f4",
"organization_id": "537650f3b77efe23a47914f3",
"organization_name": "Acme",
"name": "Disintegrating Pistol",
"delete_bot_data_enabled": true,
"data": {},
"promoted_tabs": [],
"stack_count": 2,
"event_count": 62
}]
## Get, Update [/projects/{id}]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
### Get by id [GET]
+ Response 200 (application/json)
{
"id": "537650f3b77efe23a47914f4",
"organization_id": "537650f3b77efe23a47914f3",
"organization_name": "Acme",
"name": "Disintegrating Pistol",
"delete_bot_data_enabled": true,
"data": {},
"promoted_tabs": [],
"stack_count": 2,
"event_count": 62
}
### Update project [PATCH]
+ Request (application/json)
{
"name": "Updated Disintegrating Pistol",
"delete_bot_data_enabled": true
}
+ Response 201 (application/json)
{
"id": "537650f3b77efe23a47914f4",
"organization_id": "537650f3b77efe23a47914f3",
"organization_name": "Acme",
"name": "Disintegrating Pistol",
"delete_bot_data_enabled": true,
"data": {},
"promoted_tabs": [],
"stack_count": 2,
"event_count": 62
}
## Remove [/projects/{ids}]
+ Parameters
+ ids (required, string, `537650f3b77efe23a47914f4,637650f3b77efe23a4791455`) ... A comma delimited list of project identifiers.
### Remove projects [DELETE]
+ Response 204
## Reset project data [/projects/{id}/reset-data]
### Reset project data [GET]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ Response 200
## Get configuration settings [/projects/{id}/config]
### Get the project configuration object [GET]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ Response 200 (application/json)
{
"version": 0,
"settings": {
"include_conditional_data": "true"
}
}
## Add and remove configuration settings [/projects/{id}/config/{key}]
### Add configuration value [POST]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ key (required, string, `zip-code`) ... The key name of the config object.
+ Request (text/plain)
"My config value"
+ Response 200
### Remove configuration setting [DELETE]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ key (required, string, `zip-code`) ... The key name of the config object.
+ Response 200
## Add custom data [/projects/{id}/data/{key}{?value}]
### Add custom data value [POST]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ key (required, string, `zip-code`) ... The key name of the data object.
+ value (required, string, `90210`) ... Any string value.
+ Response 200
## Remove custom data [/projects/{id}/data/{key}]
### Remove custom data value [DELETE]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ key (required, string, `zip-code`) ... The key name of the data object.
+ Response 200
## Promoted Tabs [/projects/{id}/promotedtabs/{name}]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ name (required, string, `Machine Info`) ... The tab name.
### Promote Tab [POST]
+ Response 200
### Demote Tab [DELETE]
+ Response 200
## User notification settings [/users/{user_id}/projects/{id}/notifications]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ user_id (required, string, `537b6e77b77efe102444053d`) ... A identifier of the user.
### Get user notification settings [GET]
+ Response 200 (application/json)
{
"send_daily_summary": true,
"report_new_errors": true,
"report_critical_errors": true,
"report_event_regressions": true,
"report_new_events": false,
"report_critical_events": true
}
### Set user notification settings [POST]
+ Request (application/json)
{
"send_daily_summary": true,
"report_new_errors": true,
"report_critical_errors": true,
"report_event_regressions": true,
"report_new_events": false,
"report_critical_events": true
}
+ Response 200
### Remove user notification settings [DELETE]
+ Response 200
## Check for unique name [/projects/check-name/{name}]
### Check for unique project name [GET]
Returns a `204` status code if an existing project with the specified name does not exist.
+ Parameters
+ name (required, string, `Acme`) ... The project name to check.
+ Response 204
`204` status code is returned if the name is available.
+ Body
+ Response 201
`201` status code is returned if the name is not available.
+ Body
# Group Stacks
Stack related resources of the **Stacks API**
## Get all [/stacks{?filter,sort,time,offset,mode,page,limit}]
### List all stacks [GET]
+ Parameters
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ sort (optional, string, `-date`) ... Controls the `sort` order that the data is returned in. In this example -date returns the results descending by date.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The `time offset` in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd7f",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"type": "log",
"signature_hash": "1c9c88d585f9f2ac9ed2371e5e69982cd7d342e3",
"signature_info": {
"type": "log"
},
"fixed_in_version": null,
"date_fixed": null,
"title": "(Global)",
"total_occurrences": 56,
"first_occurrence": "2020-10-16T19:28:36.165Z",
"last_occurrence": "2020-10-16T19:28:36.165Z",
"description": null,
"disable_notifications": false,
"is_hidden": false,
"is_regressed": false,
"occurrences_are_critical": false,
"references": [],
"tags": []
}]
## Get by organization [/organizations/{id}/stacks{?filter,sort,time,offset,mode,page,limit}]
### List all stacks for a given organization [GET]
+ Parameters
+ id (required, string, `537650f3b77efe23a47914f3`) ... The identifier of the organization.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ sort (optional, string, `-first`) ... Controls the `sort` order that the data is returned in. In this example -first returns the results descending by first.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd7f",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"type": "log",
"signature_hash": "1c9c88d585f9f2ac9ed2371e5e69982cd7d342e3",
"signature_info": {
"type": "log"
},
"fixed_in_version": null,
"date_fixed": null,
"title": "(Global)",
"total_occurrences": 56,
"first_occurrence": "2020-10-16T19:28:36.165Z",
"last_occurrence": "2020-10-16T19:28:36.165Z",
"description": null,
"disable_notifications": false,
"is_hidden": false,
"is_regressed": false,
"occurrences_are_critical": false,
"references": [],
"tags": []
}]
## Get newest [/new{?filter,time,offset,mode,page,limit}]
### Get newest [GET]
+ Parameters
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd7f",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"type": "log",
"signature_hash": "1c9c88d585f9f2ac9ed2371e5e69982cd7d342e3",
"signature_info": {
"type": "log"
},
"fixed_in_version": null,
"date_fixed": null,
"title": "(Global)",
"total_occurrences": 56,
"first_occurrence": "2020-10-16T19:28:36.165Z",
"last_occurrence": "2020-10-16T19:28:36.165Z",
"description": null,
"disable_notifications": false,
"is_hidden": false,
"is_regressed": false,
"occurrences_are_critical": false,
"references": [],
"tags": []
}]
## Get newest by project [/projects/{id}/stacks/new{?filter,time,offset,mode,page,limit}]
### Get newest by project [GET]
+ Parameters
+ id (optional, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd7f",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"type": "log",
"signature_hash": "1c9c88d585f9f2ac9ed2371e5e69982cd7d342e3",
"signature_info": {
"type": "log"
},
"fixed_in_version": null,
"date_fixed": null,
"title": "(Global)",
"total_occurrences": 56,
"first_occurrence": "2020-10-16T19:28:36.165Z",
"last_occurrence": "2020-10-16T19:28:36.165Z",
"description": null,
"disable_notifications": false,
"is_hidden": false,
"is_regressed": false,
"occurrences_are_critical": false,
"references": [],
"tags": []
}]
## Get most recent [/recent{?filter,time,offset,mode,page,limit}]
### Get most recent [GET]
+ Parameters
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd7f",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"type": "log",
"signature_hash": "1c9c88d585f9f2ac9ed2371e5e69982cd7d342e3",
"signature_info": {
"type": "log"
},
"fixed_in_version": null,
"date_fixed": null,
"title": "(Global)",
"total_occurrences": 56,
"first_occurrence": "2020-10-16T19:28:36.165Z",
"last_occurrence": "2020-10-16T19:28:36.165Z",
"description": null,
"disable_notifications": false,
"is_hidden": false,
"is_regressed": false,
"occurrences_are_critical": false,
"references": [],
"tags": []
}]
## Get most recent by project [/projects/{id}/stacks/recent{?filter,time,offset,mode,page,limit}]
### Get most recent by project [GET]
+ Parameters
+ id (optional, string, `537650f3b77efe23a47914f4`) ... The identifier of the project.
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.
+ mode (optional, string, `summary`) ... If no `mode` is set then the whole event object will be returned. If the `mode` is set to `summary` than a light weight object will be returned.
+ page = `1` (optional, number, `1`) ... The `page` parameter is used for pagination. This value must be greater than 0.
+ limit = `10` (optional, number, `5`) ... A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+ Response 200 (application/json)
[{
"id": "537b7255b77efe2474bfdd7f",
"organization_id": "537650f3b77efe23a47914f3",
"project_id": "537650f3b77efe23a47914f4",
"type": "log",
"signature_hash": "1c9c88d585f9f2ac9ed2371e5e69982cd7d342e3",
"signature_info": {
"type": "log"
},
"fixed_in_version": null,
"date_fixed": null,
"title": "(Global)",
"total_occurrences": 56,
"first_occurrence": "2020-10-16T19:28:36.165Z",
"last_occurrence": "2020-10-16T19:28:36.165Z",
"description": null,
"disable_notifications": false,
"is_hidden": false,
"is_regressed": false,
"occurrences_are_critical": false,
"references": [],
"tags": []
}]
## Get most frequent [/frequent{?filter,time,offset,mode,page,limit}]
### Gets most frequent [GET]
+ Parameters
+ filter (optional, string, `tag:Critical`) ... A filter that controls what data is returned from the server.
+ time (optional, string, `last 30 days`) ... The `time` filter that limits the data being returned to a specific date range.
+ offset (optional, number, `-360`) ... The time offset in minutes that controls what data is returned based on the `time` filter. This is used for time zone support.