Comments API

The Comments API allows you to get detailed information and delete comments on Bugsnag Errors.

List comments by error

Get a list of all comments for the specified Bugsnag Error.

GET /errors/:error_id/comments

Parameters

Name Description
sort What to sort results by. Can be only created_at. Default: created_at
direction The direction of the sort. Can be either asc or desc. Default: desc
per_page How many results to return per page. Default: 30

Response

Status: 200 OK
Link: <https://api.bugsnag.com/errors/50baed119bf39c1431000004/comments?offset=51f93d6af002c6686d058c49>; rel="next"

Body:

[
  {
    "id": "520042527c1074dced000017",
    "message": "This was my bug, fixed now",
    "user": {
      "account_admin": true,
      "email": "james@example.com",
      "gravatar_id": "b05c5ca80cf9fe757efdaa9e2afe4a76",
      "gravatar_url": "https://secure.gravatar.com/avatar/b05c5ca80cf9fe757efdaa9e2afe4a76",
      "html_url": "https://app.bugsnag.com/accounts/example/users/james-smith/edit",
      "id": "515fb9337c1074f6fd000007",
      "name": "James Smith",
      "projects_url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007/projects",
      "url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007"
    },
    "url": "https://api.bugsnag.com/comments/520042527c1074dced000017",
    "created_at": "2013-08-06T00:24:50Z"
  }
]

Get comment details

Get the details of the specified Comment.

GET /comments/:comment_id

Response

Status: 200 OK

Body:

{
  "id": "520042527c1074dced000017",
  "message": "This was my bug, fixed now",
  "user": {
    "account_admin": true,
    "email": "james@example.com",
    "gravatar_id": "b05c5ca80cf9fe757efdaa9e2afe4a76",
    "gravatar_url": "https://secure.gravatar.com/avatar/b05c5ca80cf9fe757efdaa9e2afe4a76",
    "html_url": "https://app.bugsnag.com/accounts/example/users/james-smith/edit",
    "id": "515fb9337c1074f6fd000007",
    "name": "James Smith",
    "projects_url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007/projects",
    "url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007"
  },
  "url": "https://api.bugsnag.com/comments/520042527c1074dced000017",
  "created_at": "2013-08-06T00:24:50Z"
}

Create a comment

Note: Only available when authenticated with user credentials.

Create a new Comment on the specified Bugsnag Error.

POST /errors/:error_id/comments

Parameters

Name Description
message The text of the comment

Response

Status: 201 Created

Body:

{
  "id": "520042527c1074dced000017",
  "message": "This was my bug, fixed now",
  "user": {
    "account_admin": true,
    "email": "james@example.com",
    "gravatar_id": "b05c5ca80cf9fe757efdaa9e2afe4a76",
    "gravatar_url": "https://secure.gravatar.com/avatar/b05c5ca80cf9fe757efdaa9e2afe4a76",
    "html_url": "https://app.bugsnag.com/accounts/example/users/james-smith/edit",
    "id": "515fb9337c1074f6fd000007",
    "name": "James Smith",
    "projects_url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007/projects",
    "url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007"
  },
  "url": "https://api.bugsnag.com/comments/520042527c1074dced000017",
  "created_at": "2013-08-06T00:24:50Z"
}

Update a comment

Update a Bugsnag Comments’s message. Responds with the newly updated Project.

PATCH /comments/:comment_id

Parameters

Name Description
message The text of the comment

Response

Status: 200 OK

Body:

{
  "id": "520042527c1074dced000017",
  "message": "This was my bug, fixed now",
  "user": {
    "account_admin": true,
    "email": "james@example.com",
    "gravatar_id": "b05c5ca80cf9fe757efdaa9e2afe4a76",
    "gravatar_url": "https://secure.gravatar.com/avatar/b05c5ca80cf9fe757efdaa9e2afe4a76",
    "html_url": "https://app.bugsnag.com/accounts/example/users/james-smith/edit",
    "id": "515fb9337c1074f6fd000007",
    "name": "James Smith",
    "projects_url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007/projects",
    "url": "https://api.bugsnag.com/users/515fb9337c1074f6fd000007"
  },
  "url": "https://api.bugsnag.com/comments/520042527c1074dced000017",
  "created_at": "2013-08-06T00:24:50Z"
}

Delete a comment

Delete a Comment from Bugsnag.

DELETE /comments/:comment_id

Response

Status: 204 No Content