project-events.json 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. {
  2. "get": {
  3. "tags": ["Events"],
  4. "description": "Return a list of error events bound to a project.",
  5. "operationId": "List a Project's Error Events",
  6. "parameters": [
  7. {
  8. "name": "organization_id_or_slug",
  9. "in": "path",
  10. "description": "The id or slug of the organization the events belong to.",
  11. "required": true,
  12. "schema": {
  13. "type": "string"
  14. }
  15. },
  16. {
  17. "name": "project_id_or_slug",
  18. "in": "path",
  19. "description": "The id or slug of the project the events belong to.",
  20. "required": true,
  21. "schema": {
  22. "type": "string"
  23. }
  24. },
  25. {
  26. "name": "full",
  27. "in": "query",
  28. "description": "If this is set to true then the event payload will include the full event body, including the stacktrace. \nSet to true to enable.",
  29. "schema": {
  30. "type": "boolean"
  31. }
  32. },
  33. {
  34. "$ref": "../../components/parameters/pagination-cursor.json#/PaginationCursor"
  35. }
  36. ],
  37. "responses": {
  38. "200": {
  39. "description": "Success",
  40. "content": {
  41. "application/json": {
  42. "schema": {
  43. "type": "array",
  44. "items": {
  45. "$ref": "../../components/schemas/event.json#/Event"
  46. }
  47. },
  48. "example": [
  49. {
  50. "eventID": "9fac2ceed9344f2bbfdd1fdacb0ed9b1",
  51. "tags": [
  52. {
  53. "key": "browser",
  54. "value": "Chrome 60.0"
  55. },
  56. {
  57. "key": "device",
  58. "value": "Other"
  59. },
  60. {
  61. "key": "environment",
  62. "value": "production"
  63. },
  64. {
  65. "value": "fatal",
  66. "key": "level"
  67. },
  68. {
  69. "key": "os",
  70. "value": "Mac OS X 10.12.6"
  71. },
  72. {
  73. "value": "CPython 2.7.16",
  74. "key": "runtime"
  75. },
  76. {
  77. "key": "release",
  78. "value": "17642328ead24b51867165985996d04b29310337"
  79. },
  80. {
  81. "key": "server_name",
  82. "value": "web1.example.com"
  83. }
  84. ],
  85. "dateCreated": "2020-09-11T17:46:36Z",
  86. "user": null,
  87. "message": "",
  88. "title": "This is an example Python exception",
  89. "id": "dfb1a2d057194e76a4186cc8a5271553",
  90. "platform": "python",
  91. "event.type": "error",
  92. "groupID": "1889724436"
  93. }
  94. ]
  95. }
  96. }
  97. },
  98. "403": {
  99. "description": "Forbidden"
  100. }
  101. },
  102. "security": [
  103. {
  104. "auth_token": ["project:read"]
  105. }
  106. ]
  107. }
  108. }