Skip to main content

List symbolication jobs

Endpoint

/o?method=crash_jobs

Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

Lists symbolication jobs with optional platform/status filtering and DataTable pagination.

Authentication

  • Authentication methods:
    • API Key (parameter): api_key=YOUR_API_KEY
    • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
    • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

  • Required permission: Read on the crashes feature

Request Parameters

ParameterTypeRequiredDescription
methodStringYesMust be crash_jobs
app_idStringYesApplication identifier
platformStringNoFilter by job platform
statusStringNoFilter by status (started, in process, success, errored)
iDisplayStartNumberNoPagination offset (DataTable)
iDisplayLengthNumberNoPage size (DataTable)
sSearchStringNoSearch term
outputFormatStringNofull (default) or rows
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication

Configuration Impact

SettingDefaultAffectsUser-visible impact
crashes.*Crashes feature defaultsCrash-job query behavior and filtering options used by this endpoint.Changes to crashes settings can alter which job rows are returned or how they are grouped/filtered.

Response

Success Response

Default (outputFormat=rows):

[
{
"_id": "65c5de2a2c5f5300121a0011",
"ts": 1739624770000,
"platform": "JavaScript",
"build": "1.4.2",
"status": "success",
"log": ["Started", "Stack trace updated"]
}
]

outputFormat=full:

{
"sEcho": "1",
"iTotalRecords": 2,
"iTotalDisplayRecords": 2,
"aaData": [
{
"_id": "65c5de2a2c5f5300121a0011",
"ts": 1739624770000,
"platform": "JavaScript",
"build": "1.4.2",
"status": "success",
"log": ["Started", "Stack trace updated"]
}
]
}

Response Fields

FieldTypeDescription
(root value)Array or ObjectArray by default (outputFormat=rows), or DataTable object for outputFormat=full.
[].platformStringSymbolication path/platform label (rows output).
[].buildStringBuild value used for the job (rows output).
[].statusStringJob status (rows output).
[].logArrayJob log entries (rows output).
sEchoStringDataTable echo value (outputFormat=full).
iTotalRecordsNumberTotal matching records before search (outputFormat=full).
iTotalDisplayRecordsNumberTotal records after search/filter (outputFormat=full).
aaDataArrayJob rows (outputFormat=full).

Error Responses

HTTP StatusResponse
200false when aggregation fails
401{ "result": "User does not exist" } or auth validation message

Behavior/Processing

  • Requires Read permission on the crashes feature.
  • Queries symbolication_jobs with an initial match on app_id.
  • Adds exact-match filters for platform and status when those query parameters are provided.
  • Uses the shared DataTable helper with column order ts, platform, build, status, and log.
  • Search applies to platform, build, status, and log; default sorting is by created_at descending.
  • The handler excludes app_id from returned rows and defaults to outputFormat=rows unless a DataTable output format is requested.
  • Aggregation errors return false.

Database Collections

CollectionUsed forData touched by this endpoint
countly.symbolication_jobsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.

Examples

Example 1: List all jobs

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

Example 2: Filter by status and platform

/o?method=crash_jobs&app_id=5f9c8a3b4d1e2a001f3b4567&platform=JavaScript&status=success&api_key=YOUR_API_KEY

Ⓔ Enterprise

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions


Last Updated

2026-04-18