Skip to main content

Download symbol file

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=download_symbol

Overview​

Downloads a stored symbol file. For JavaScript multi-file symbol documents, file_id is required.

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 download_symbol
app_idStringYesApplication identifier
symbol_idStringYesSymbol document ID
file_idStringConditionalRequired when symbol doc uses filenames[]
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication

Examples​

Example 1: Download single-file symbol​

/o?method=download_symbol&app_id=5f9c8a3b4d1e2a001f3b4567&symbol_id=65c5dc9e2c5f5300121a0001&api_key=YOUR_API_KEY

Example 2: Download one file from JavaScript multi-file symbol​

/o?method=download_symbol&app_id=5f9c8a3b4d1e2a001f3b4567&symbol_id=65c5dc9e2c5f5300121a0001&file_id=tmp_1739624449899&api_key=YOUR_API_KEY

Response​

Success Response​

Returns raw binary file stream with headers:

  • Content-Type: application/octet-stream
  • Content-Disposition: attachment;filename=<symbol file>

Response Fields​

FieldTypeDescription
Binary streamFileDownloaded symbol file bytes

Error Responses​

HTTP StatusResponse
400{ "result": "Missing parameter \"symbol_id\"" }
400{ "result": "Missing parameter \"file_id\"" }
400{ "result": "Parameter \"file_id\" is not allowed for single-file symbols" }
404{ "result": "Symbol file document <id> not found" }
404{ "result": "Symbol file for given \"file_id\" not found" }
404{ "result": "Cannot find symbol file" }
500{ "result": "Error getting symbol file document <id>" }
500{ "result": "Error outputting stream" }

Behavior​

  1. Loads symbol metadata from app symbol collection.
  2. Resolves single-file (filename) or multi-file (filenames) storage key.
  3. Streams file from crash_symbols bucket.
Implementation details

Database Collections

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