Skip to main content

List symbols

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_symbols

Overview

Returns all uploaded symbol documents for the selected app.

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_symbols
app_idStringYesApplication identifier
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication

Examples

Example 1: List symbols

/o?method=crash_symbols&app_id=5f9c8a3b4d1e2a001f3b4567&api_key=YOUR_API_KEY

Response

Success Response

[
{
"_id": "65c5dc9e2c5f5300121a0001",
"platform": "android",
"build": "1.4.2",
"note": "Production mapping file",
"ts": 1739624452,
"filename": "mapping.txt"
}
]

Response Fields

FieldTypeDescription
_idStringSymbol document ID
platformStringPlatform (android, ios, javascript, android_native, etc.)
buildString/ArrayBuild identifier(s) matched during symbolication
noteStringOptional note
tsNumberUpload timestamp (unix seconds)
filenameStringSingle-file symbol name
filenamesArrayMulti-file symbols metadata (name, id, size) for JavaScript
sym_tool_verStringSymbol tool version when uploaded via SDK flow

Error Responses

HTTP StatusResponse
401{ "result": "User does not exist" } or auth validation message

Behavior

  • Requires Read permission on the crashes feature.
  • Reads all documents from app_crashsymbols{app_id}.
  • Sorts symbols by _id ascending before returning them.
  • Does not apply pagination, search, or platform/build filters in this handler.
  • If the collection read fails or returns no rows, the handler returns an empty array.
  • Returned documents are not projected; any stored metadata fields on the symbol document can be present.
Implementation details

Configuration Impact

SettingDefaultAffectsUser-visible impact
crashes.*Crashes feature defaultsCrash-symbol data retrieval and filtering behavior.Changes to crash settings can alter which crash-symbol records are returned.

Database Collections

CollectionUsed forData touched by this endpoint
countly.app_crashsymbols{app_id}Endpoint data sourceStores endpoint-related records this endpoint reads or modifies.