Skip to main content

Crashes - Add Comment

Endpoint

/i/crashes/add_comment

Overview

Adds a comment to a crash group.

Authentication

Countly API supports three authentication methods:

  1. api_key=YOUR_API_KEY
  2. auth_token=YOUR_AUTH_TOKEN
  3. countly-token: YOUR_AUTH_TOKEN

Permissions

Requires crashes Create permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
app_idStringYesTarget app ID for validation context.
argsJSON String (Object)YesComment payload.
args.app_idStringYesApp ID used by comment write path.
args.crash_idStringYesCrash group ID.
args.textStringNoComment text. Default empty string.
args.timeNumberNoComment timestamp in ms. Default current time.

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when request is accepted.

Error Responses

  • 400
{
"result": "Please provide args parameter"
}

Standard auth/permission errors from create validation can also be returned.

Behavior/Processing

  • Builds comment object with _id, author, author_id, time, text.
  • Comment _id is SHA1 hash of app/crash/comment payload.
  • Pushes comment into crash group comments array.
  • Emits crash_added_comment system log action.

Database Collections

CollectionUsed forData touched by this endpoint
countly.app_crashgroups{appId}Crash commentsPushes new entry into comments array.
countly.systemlogsAudit trailReceives crash_added_comment action.

Examples

/i/crashes/add_comment?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&args={"app_id":"6991c75b024cb89cdc04efd2","crash_id":"crash_group_1","text":"Investigating root cause"}

Last Updated

2026-03-07