Skip to main content

Crashes - Reports Read

Endpoint

/o?method=reports

Overview

Returns crash report documents by report id(s).

Authentication

Countly API supports three authentication methods:

  1. api_key=YOUR_API_KEY
  2. auth_token=YOUR_AUTH_TOKEN
  3. countly-token: YOUR_AUTH_TOKEN

Permissions

Requires crashes Read permission.

Request Parameters

ParameterTypeRequiredDescription
methodStringYesMust be reports.
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
app_idStringYesApp id.
report_idsString (JSON Array)NoList of report ids.
report_idStringNoSingle report id. Used when report_ids is not provided.

Response

Success Response

{
"65f1f7b2ad5b9b001f12ab34": {
"_id": "65f1f7b2ad5b9b001f12ab34",
"a": "6991c75b024cb89cdc04efd2",
"e": "[CLY]_crash",
"n": "crash_group_1",
"uid": "user-123"
}
}

Response Fields

FieldTypeDescription
(root)ObjectReport map keyed by report document id.
{report_id}ObjectRaw crash report document from drill events collection.

Error Responses

Standard authentication/authorization errors from read validation.

Behavior/Processing

  • If report_ids is present, endpoint parses it as JSON array.
  • If report_ids is absent and report_id is present, endpoint creates a single-item list.
  • Parse failures fall back to empty id list and return {}.

Database Collections

CollectionUsed forData touched by this endpoint
countly_drill.drill_eventsCrash report sourceReads crash reports where a is app id, e is [CLY]_crash, and n matches report ids.

Examples

Read multiple reports

/o?method=reports&api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&report_ids=["65f1f7b2ad5b9b001f12ab34","65f1f7b2ad5b9b001f12ab35"]

Read one report

/o?method=reports&api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&report_id=65f1f7b2ad5b9b001f12ab34

Last Updated

2026-03-05