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
- API Key (parameter):
Permissions
- Required permission:
Readon thecrashesfeature
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
method | String | Yes | Must be crash_jobs |
app_id | String | Yes | Application identifier |
platform | String | No | Filter by job platform |
status | String | No | Filter by status (started, in process, success, errored) |
iDisplayStart | Number | No | Pagination offset (DataTable) |
iDisplayLength | Number | No | Page size (DataTable) |
sSearch | String | No | Search term |
outputFormat | String | No | full (default) or rows |
api_key | String | Yes (or auth_token) | API key authentication |
auth_token | String | Yes (or api_key) | Auth token authentication |
Configuration Impact
| Setting | Default | Affects | User-visible impact |
|---|---|---|---|
crashes.* | Crashes feature defaults | Crash-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
| Field | Type | Description |
|---|---|---|
(root value) | Array or Object | Array by default (outputFormat=rows), or DataTable object for outputFormat=full. |
[].platform | String | Symbolication path/platform label (rows output). |
[].build | String | Build value used for the job (rows output). |
[].status | String | Job status (rows output). |
[].log | Array | Job log entries (rows output). |
sEcho | String | DataTable echo value (outputFormat=full). |
iTotalRecords | Number | Total matching records before search (outputFormat=full). |
iTotalDisplayRecords | Number | Total records after search/filter (outputFormat=full). |
aaData | Array | Job rows (outputFormat=full). |
Error Responses
| HTTP Status | Response |
|---|---|
| 200 | false when aggregation fails |
| 401 | { "result": "User does not exist" } or auth validation message |
Behavior/Processing
- Requires
Readpermission on thecrashesfeature. - Queries
symbolication_jobswith an initial match onapp_id. - Adds exact-match filters for
platformandstatuswhen those query parameters are provided. - Uses the shared DataTable helper with column order
ts,platform,build,status, andlog. - Search applies to
platform,build,status, andlog; default sorting is bycreated_atdescending. - The handler excludes
app_idfrom returned rows and defaults tooutputFormat=rowsunless a DataTable output format is requested. - Aggregation errors return
false.
Database Collections
| Collection | Used for | Data touched by this endpoint |
|---|---|---|
countly.symbolication_jobs | Endpoint data source | Stores 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
Related Endpoints
Ⓔ 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