Skip to main content

Crashes - Hide Crash Groups

Endpoint

/i/crashes/hide

Overview

Marks one or more crash groups as hidden.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

Requires crashes Update permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
app_idStringYesTarget app ID.
argsJSON String (Object)YesAction payload.
args.crash_idStringNoSingle crash group ID.
args.crashesArray of StringsNoList of crash group IDs.

Provide args.crashes or args.crash_id.

Examples

/i/crashes/hide?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&args={"crashes":["crash_group_1","crash_group_2"]}

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when operation completes.

Error Responses

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

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

Behavior

  • Resolves crash IDs from args.crashes or [args.crash_id].
  • Updates matching crash groups with is_hidden=true.
  • Emits one crash_hidden system log action per crash ID.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.app_crashgroups{appId}Crash group visibilityUpdates is_hidden=true for selected groups.
countly.systemlogsAudit trailReceives crash_hidden action(s).