Skip to main content

Get crash report

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/o?method=crash_report

Overview

Fetches one crash report record by report_id.

Authentication

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

Permissions

  • Required permission: Read on the crashes feature

Request Parameters

ParameterTypeRequiredDescription
methodStringYesMust be crash_report
app_idStringYesApplication identifier
report_idStringYesCrash report identifier
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication

Examples

Example 1: Get report by ID

/o?method=crash_report&app_id=5f9c8a3b4d1e2a001f3b4567&report_id=65c5df182c5f5300121a0019&api_key=YOUR_API_KEY

Response

Success Response

{
"_id": "65c5df182c5f5300121a0019",
"uid": "user_12345",
"group": "65c5dd952c5f5300121a0009",
"error": "TypeError: Cannot read properties of undefined",
"os": "Android",
"app_version": "1.4.2",
"ts": 1739625012
}

Response Fields

FieldTypeDescription
_idStringCrash report ID
uidStringUser identifier
groupStringCrash group ID
errorStringCrash stack/error body
tsNumberEvent timestamp
osStringOS name
app_versionStringApp version

Error Responses

HTTP StatusResponse
400{ "result": "Missing parameter \"report_id\"" }
400{ "result": "Report <id> not found" }
500{ "result": "Error fetching crash report <id>" }

Behavior

  • Requires Read permission on the crashes feature.
  • Requires report_id; missing values return Missing parameter "report_id".
  • Looks up a single crash report through the crashes data layer with query {_id: report_id} and limit=1.
  • Returns the report document exactly as returned by the crashes table helper. The available fields depend on the crash backend and stored crash payload.
  • If no report matches the ID, returns Report <id> not found.
  • Query failures are logged and returned as Error fetching crash report <id>.
Implementation details

Configuration Impact

SettingDefaultAffectsUser-visible impact
crashes.*Crashes feature defaultsCrash-report lookup behavior and source selection used by this endpoint.Changes to crashes settings can affect how report details are retrieved and what metadata is available in output.

Database Collections

CollectionUsed forData touched by this endpoint
countly.crashdata_{appId} / crash query backendCrash report lookup sourceStores crash report documents queried by report_id through the crashes data layer.
countly_drill.drill_events (backend-dependent)Crash event enrichment sourceProvides crash event fields when report data is resolved through drill-based crash query paths.